search

SustainableUrbanDesign / app

Prototype toolkit for sustainable urban design at the speed of thought.
https://sustainableurbandesign.space/
GNU Affero General Public License v3.0
27 stars 9 forks source link

Move developer documentation and docker-compose to subfolder #124

Open brylie opened 4 years ago

brylie commented 4 years ago

The project root and README are contain a lot of details intended for developers, making it hard to find information about contributors. Move the developer documentation and script(s) into a subdirectory and include a link in the README.

brylie commented 4 years ago

We are using mkDocs for project documentation, so it would be natural for the developer sections of the README to be moved to mkDocs.

https://github.com/SustainableUrbanDesign/app/tree/master/docs/docs

Let's leave the docker-compose.yml file as it is for now.