init master with README
authorNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 13:54:45 +0000 (15:54 +0200)
committerNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 13:54:45 +0000 (15:54 +0200)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..54b1092
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Template
+
+Some templates that you can use via:
+* starting with it and adding your sources
+* `git pull --allow-unrelated-histories --no-rebase`
+
+The repository is available at: git@github.com:nikiroo/templates.git
+
+The available templates are present in their own branches, but also used as
+modules in the master branch, each in a directoy named after its branch name.
+
+Currently, those are available:
+* `c-master`: structure and Makefile for a main project
+* `c-subtree`: Makefile adapted to submodule-ready C projects
+* `c-libtree`: Makefile adapted to submodule-ready C libraries
+* `c-tsttree`: Makefile adapted to submodule-ready C test projects
+* `java`: structure and Makefile for a java project
+