WIP

Fermium · May 5, 2017 · eb44970 · eb44970
1 parent 00ca4db
commit eb44970
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,26 @@
+History/
+
+*.PrjPCBStructure
+
+#Previews should remain locals
+*.SchDocPreview
+*.PcbDocPreview
+__Previewss
+
+#Useless extensions
+*.Dat
+*.REP 
+*.TLT
+*.LOG
+*.htm
+*.$$$
+*.log
+
+# Default useless output folders
+Project\ Outputs/
+Project\ Logs/
+
+
+# Ignore exports
+exports/
+!exports/README.md
diff --git a/README.md b/README.md
@@ -1,2 +1,17 @@
-# altium-on-git
-Boilerplate repository to use Altium Designer on git
+# Altium on git
+
+Boilerplate repository to use Altium Designer on git.
+
+
+# Instruction
+
+This repository is a well-tested starting point to use Altium Designer in a mixed Unix-Windows environment.
+
+If you run Altium in a VM, keeping the files on Linux, you need this.
+
+```shell
+git clone [email protected]:fermiumlabs/altium-on-git.git
+git submodule update --init --recursive
+```
+
+When you save a new schematic file, save it in ASCII. This will keep the repository size low.
diff --git a/boards/board1/README.md b/boards/board1/README.md
@@ -0,0 +1,3 @@
+# Board 1
+
+This board does xxx
diff --git a/boards/board2/README.md b/boards/board2/README.md
@@ -0,0 +1,3 @@
+# Board 2
+
+This board does xxx
diff --git a/boards/board3/README.md b/boards/board3/README.md
@@ -0,0 +1,3 @@
+# Board 3
+
+This board does xxx
diff --git a/libraries/README.md b/libraries/README.md
@@ -0,0 +1,5 @@
+# Libraries
+
+Place your libraries here.
+
+You should keep them in submodules. Find how [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules)