Code Monkey home page Code Monkey logo

docs's Introduction

docs

Software architecture documentation for Endless Sky.

docs's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

The html files with component details appear to be missing

index.md refers to six .html files with details on components, but when clicking on any of the links then some 404 message shows up instead of the expected .html file. I also don't see the .html files in the directory structure.

If the files exist, then please add them (or fix the links). If they don't exist yet, then please add some "under construction" placeholder.

Add some text about locking and multithreading in the game

Endless sky appears to use multi-threading and locking.

If developers inexperienced with the codebase (or inexperienced with threading) start making code-changes to structures shared between threads, then the risk of race-conditions and deadlocks could increase.

This request is to get some text in this documentation that describes which threads are used in the game and some text on which classes/areas/datastructures are expected to use locking (and when).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.