From fb1243f5690ef6b7aaddeb95535e942a34e5d064 Mon Sep 17 00:00:00 2001 From: Michael Schwarz Date: Thu, 25 Dec 2014 16:02:39 +0100 Subject: Added a section describing the repository structure to the readme. --- readme.creole | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'readme.creole') 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 -- cgit