diff --git a/README.md b/README.md index 48ab16ec..01fd3668 100644 --- a/README.md +++ b/README.md @@ -123,40 +123,50 @@ If you need help, you can watch documentation sites: You found a bug? You can help ursina by posting it in [the issues](https://github.com/pokepetter/ursina/issues), or by making a [pull request](https://github.com/pokepetter/ursina/pulls) -## Project Structure -``` ## Project Structure -📁docs - 📃index.txt - 📃documentation.txt - 📃inventory_tutorial.txt - ... - # text files for the website. gets turned into .html files with sswg. - - 📃cheat_sheet.html - # auto generated documentation made with documentation_generator.py. - - 📃tutorial_generator.py - # turns specific .py files into .txt files, which can then be turned into .html by sswg. - # this extracts the comments from the source files into description for that step and the code after into code blocks. - # see platformer_tutorial.py for an example. - -📁samples # small example games. - -📁ursina # the actual ursina module. - 📁audio # built-in audio clips. - 📁editor # the 3d level editor for ursina. - 📁fonts # built-in fonts. - 📁models # .blend files, source files, for built-in 3d models. - 📁procedural # classes for generating 3d models, like Cylinder, Quad and Terrain. - 📁models_compressed # .blend files converted to .ursinamesh. - 📁prefabs # higher level classes like Draggable, Slider, Sprite, etc. - - 📃__init__.py - 📃application.py - 📃audio.py - ... - # ursina base modules, like code for Entity, input_handler, Text, window and so on. +- 📁docs + - 📃index.txt + - 📃documentation.txt + - 📃inventory_tutorial.txt + + + text files for the website. gets turned into .html files with [sswg](https://github.com/pokepetter/sswg). + - ... + + - 📃cheat_sheet.html + + auto generated documentation made with [documentation_generator.py](https://github.com/pokepetter/ursina/blob/master/docs/documentation_generator.py). + + - 📃tutorial_generator.py + + turns specific .py files into .txt files, which can then be turned into .html by [sswg](https://github.com/pokepetter/sswg). + + this extracts the comments from the source files into description for that step and the code after into code blocks. + + see [platformer_tutorial.py](https://github.com/pokepetter/ursina/blob/master/docs/platformer_tutorial.py) for an example. + +- 📁samples + - small example game + +- 📁ursina + + the actual ursina module. + - 📁audio + + built-in audio clips. + - 📁editor + + the 3d level editor for ursina. + - 📁fonts + + built-in fonts. + - 📁models + + .blend files, source files, for built-in 3d models. + - 📁procedural + + classes for generating 3d models, like Cylinder, Quad and Terrain. + - 📁models_compressed + + .blend files converted to .ursinamesh. + - 📁prefabs + + higher level classes like Draggable, Slider, Sprite, etc. + + - 📃__init__.py + - 📃application.py + - 📃audio.py + - ... + + ursina base modules, like code for Entity, input_handler,Text, window and so on. + + + -```