diff options
| author | Michael Schwarz <michi.schwarz@gmail.com> | 2014-12-25 16:02:39 +0100 |
|---|---|---|
| committer | Michael Schwarz <michi.schwarz@gmail.com> | 2014-12-25 16:02:39 +0100 |
| commit | fb1243f5690ef6b7aaddeb95535e942a34e5d064 (patch) | |
| tree | 1fbc891a6ab774a04e538d5d9a946838100eb04e | |
| parent | d08e4be25f157d59075e0b2a669e6388cb462474 (diff) | |
| download | pogojig-fb1243f5690ef6b7aaddeb95535e942a34e5d064.tar.gz pogojig-fb1243f5690ef6b7aaddeb95535e942a34e5d064.tar.bz2 pogojig-fb1243f5690ef6b7aaddeb95535e942a34e5d064.zip | |
Added a section describing the repository structure to the readme.
| -rw-r--r-- | readme.creole | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/readme.creole b/readme.creole index 673e7fb..5cfff98 100644 --- a/readme.creole +++ b/readme.creole @@ -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 |