Skip to content

Commit

Permalink
Document the directory structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Androcas committed Jan 22, 2017
1 parent 2b14450 commit 4720b2c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ You may want to inspect `<my_dir>/gfx/Cargo.toml` for other modules typically us
## Note

gfx is still in development. API may change with new backends/features to be implemented.
If you are interested in helping out, please contact the developers on [Gitter](https://gitter.im/gfx-rs/gfx).
If you are interested in helping out, checkout [contrib.md](info/contrib.md) and do not hesitate to contact the developers on [Gitter](https://gitter.im/gfx-rs/gfx).
17 changes: 10 additions & 7 deletions info/contrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ There is also a [Waffle board](https://waffle.io/gfx-rs/gfx-rs), which you can u

Finally, feel free to hop on [#rust-gamedev](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev).

### Issues

Labels are formatted as "M-render", where "M" is a category among those:
* **T** = Type: *bug*, *discussion*, *doc*, *feature*, *optimization*, *refactor*
* **S** = Status: *blocked*, *duplicate*, *invalid*, *ready*, *working*
* **D** = Difficulty: *easy*, *hard*, *medium*
* **M** = Module: *device*, *user*, *render*, *structure*
### Directory Structure

* _examples_ : GFX's examples
* _tests_ : GFX's tests
* _info_ : Information and documentation
* _src_ : gfx_app, an application framework for GFX
* _src/core_ : gfx_core, core structures and the interface that backends must provide
* _src/backend_ : The backends implementations
* _src/render_ : The main gfx package
* _src/window_ : Different backends to create windows and initialize their graphics

### Code

Expand Down

0 comments on commit 4720b2c

Please sign in to comment.