Update README content to explain how to clone our repositories
authorNathael Pajani <nathael.pajani@ed3l.fr>
Tue, 31 Jan 2023 00:08:36 +0000 (01:08 +0100)
committerNathael Pajani <nathael.pajani@ed3l.fr>
Tue, 31 Jan 2023 00:08:36 +0000 (01:08 +0100)
README

diff --git a/README b/README
index 79d56e0..3189d0e 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,23 @@ This repository holds the libraries used by projects and boards designed by
  Techno-Innov.
 
 It should be used as a base directory to hold our projects, which you should
- clone in a sub-directory of your choice (we use those mentioned in the
- .gitignore file, but any directory name will do the job).
+ clone in a sub-directory of your choice. We use names like those in the git
+ paths, but any directory name will do the job. If, for example, you're
+ interested in our "orangepi", "demo", and "rfsub1g" designs, you should end up
+ with something like this :
+ - Schemas /
+   |- Lib
+   |- Adapters /
+      |- OrangePi /
+   |- Modules /
+      |- RF_Sub1GHz /
+      |- Demo /
+ Which is made by the succession of these commands :
+  git clone git://git.techno-innov.fr/elec/base Schemas
+  mkdir -p Schemas/{Adapters,Modules}
+  git clone git://git.techno-innov.fr/elec/adapters/orangepi Schemas/Adapters/OrangePi
+  git clone git://git.techno-innov.fr/elec/modules/rfsub1g Schemas/Modules/RF_Sub1GHz
+  git clone git://git.techno-innov.fr/elec/modules/demo Schemas/Modules/Demo
 
 We are not using "official" KiCaD libraries due to the constant changes in
  KiCaD formats, library contents and organisation between versions, making