added readme file to each subdirectory

tony-gm · Jan 9, 2016 · 5d88449 · 5d88449
1 parent a1657a3
commit 5d88449
Show file tree

Hide file tree

Showing 14 changed files with 55 additions and 4 deletions.
diff --git a/3rdparty/README.md b/3rdparty/README.md
@@ -0,0 +1,3 @@
+# 3rd-party Stuff
+
+This directory contains 3rd-party stuff (libraries, applications, ...).
diff --git a/readme/LICENSE.txt → LICENSE.txt b/readme/LICENSE.txt → LICENSE.txt
diff --git a/dev/README.md b/dev/README.md
@@ -0,0 +1,8 @@
+# Development Resources
+
+This directory contains various resources for developers:
+- A [demo workspace](https://github.com/LibrePCB/demo-workspace) for testing LibrePCB
+- Some diagrams about the software architecture (class diagrams, library architecture diagrams, ...)
+- Docker containers
+- [Doxygen documentation](http://librepcb.github.io/LibrePCB-Doxygen/master/)
+- and more...
diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,3 @@
+# User Documentation
+
+This directory contains the user documentation for LibrePCB (not yet available).
diff --git a/doc/todo.txt b/doc/todo.txt
diff --git a/i18n/README.md b/i18n/README.md
@@ -0,0 +1,5 @@
+# LibrePCB Translation Files
+
+This directory contains the translation files for the LibrePCB application and other tools.
+- *.ts files are generated by Qt's ```lupdate``` (triggered manually)
+- *.qm files are generated by Qt's ```lrelease``` (triggered during the qmake build process of LibrePCB)
diff --git a/img/README.md b/img/README.md
@@ -0,0 +1,6 @@
+# Images
+
+This directory contains all images which are required in the LibrePCB application or other tools.
+
+- Most images are from the "Open Icon Library": http://openiconlibrary.sourceforge.net/
+- Some images are from https://www.iconfinder.com/
diff --git a/img/readme.txt b/img/readme.txt
diff --git a/librepcb/README.md b/librepcb/README.md
@@ -0,0 +1,7 @@
+# LibrePCB Application
+
+This directory contains the qmake project of the LibrePCB application.
+
+The dependencies between application and static libraries are shown in the [architecture overview diagram](../dev/diagrams/svg/architecture_overview.svg):
+
+![Architecture Overview Diagram](../dev/doxygen/images/architecture_overview.png)
diff --git a/libs/README.md b/libs/README.md
@@ -0,0 +1,7 @@
+# Static Libraries
+
+This directory contains all static libraries (as qmake projects) required to build the LibrePCB application and other tools. 
+
+The dependencies between these libraries are shown in the [architecture overview diagram](../dev/diagrams/svg/architecture_overview.svg):
+
+![Architecture Overview Diagram](../dev/doxygen/images/architecture_overview.png)
diff --git a/packaging/README.md b/packaging/README.md
@@ -0,0 +1,3 @@
+# Packaging
+
+This directory contains files required to create application packages for deployment (debian packages, windows installer, ...).
diff --git a/readme/README.txt b/readme/README.txt
diff --git a/tests/README.md b/tests/README.md
@@ -0,0 +1,3 @@
+# Unit/Integration Tests
+
+This directory contains unit/integration tests (as qmake projects) for all static libraries. Google Mock (gmock) is used as testing framework.
diff --git a/tools/README.md b/tools/README.md
@@ -0,0 +1,10 @@
+# Tools
+
+This directory contains some qmake projects to build additional tools, like
+- an importer for Eagle libraries (only for developers)
+- a tool to generate random UUIDs (only for developers)
+- tools to update workspace and project libraries to a newer file format (only for developers)
+
+The dependencies between applications and static libraries are shown in the [architecture overview diagram](../dev/diagrams/svg/architecture_overview.svg):
+
+![Architecture Overview Diagram](../dev/doxygen/images/architecture_overview.png)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# 3rd-party Stuff

		This directory contains 3rd-party stuff (libraries, applications, ...).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# User Documentation

		This directory contains the user documentation for LibrePCB (not yet available).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Packaging

		This directory contains files required to create application packages for deployment (debian packages, windows installer, ...).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Unit/Integration Tests

		This directory contains unit/integration tests (as qmake projects) for all static libraries. Google Mock (gmock) is used as testing framework.