jaseg/pogojig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added a section describing the repository structure to the readme.

Browse source
This commit is contained in:
Michael Schwarz 2014-12-25 16:02:39 +01:00
parent d08e4be25f
commit fb1243f569
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
readme.creole
View file

@ -1,5 +1,12 @@
= Readme
== Repository structure
This repository, as it is maintained on [http://github.com/Feuermurmel/openscad-template|GitHub], contains two important branches, Branch `master` and `examples`. `master` contains an empty project which is ready to be clones and used for new project.
Branch `examples` additionally contains a few example source files which are ready to be compiled. The root directory on that branch also contains a second text document `examples.creole`, describing the example project in more detail.
== Prerequisites
* OpenSCAD snapshot > 2014.11.05