doc: move generic documentation into doc directory

Put the generic information in the doc/ directory. A lot of project management systems look into the project root directory for some typical file. Create a symbolic link for those files. Signed-off-by: Federico Vaga <federico.vaga@cern.ch>

doc: move generic documentation into doc directory
Put the generic information in the doc/ directory. A lot of project management systems look into the project root directory for some typical file. Create a symbolic link for those files. Signed-off-by: Federico Vaga <federico.vaga@cern.ch>
16d5cd88 · Federico Vaga · Federico Vaga · 68c57db8 · 68c57db8 · 16d5cd88
Commit 16d5cd88 authored Nov 16, 2016 by Federico Vaga Committed by Federico Vaga Sep 14, 2017
12 changed files
--- a/CHANGELOG
+++ b/CHANGELOG
-# Change Log
-
-## [2.0] - 2016-06-08
-### Changed
- Project change name to Mock Turtle. this means renaming all files
-  functions, data structures, enumerates and variables to a new
-  convention
- port output real-time application to the real-time library
- improve kernel driver performance
-### Added
- unittest
-
-## [1.1] - 2015-10-20
-### Changed
- minor changes in API behaviour on error
-
-## [1.0] - 2015-09-17
-
- first release White Rabbit Node Core
-
-[2.0] http://www.ohwr.org/projects/wr-node-core-sw/repository/show?rev=mock-turtle-2.0
-[1.1] http://www.ohwr.org/projects/wr-node-core-sw/repository/show?rev=mock-turtle-1.1
-[1.0] http://www.ohwr.org/projects/wr-node-core-sw/repository/show?rev=mock-turtle-1.0
--- a/CHANGELOG
+++ b/CHANGELOG
+doc/CHANGELOG
\ No newline at end of file
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
-CODE
-====
-The projects use the following languages:
- C for the driver, the user-space library and the embedded library
- Python to export library functionality to Python
-
-RULES
-=====
-The master branch is protected so you need special permission to touch it.
-
-Do you development on your own branch and push it.
-
-In the project we are following the Linux kernel code style.
-
-All the functions, defines, structures, enumeraters exported should use
-the `trl_` prefix.
-
-All file names start with ''mockturtle-''
\ No newline at end of file
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
+doc/CONTRIBUTING.md
\ No newline at end of file
--- a/LICENSE
+++ b/LICENSE
--- a/LICENSE
+++ b/LICENSE
+doc/LICENSE
\ No newline at end of file
--- a/README.md
+++ b/README.md
-Mock Turtle
-===========
-The project provide the software necessary to access Mock Turtle
-infrastructure on an FPGA.
-
-The software stack for the Mock Turtle is made of:
- a driver that allow you to communication with the Mock Turtle CPUs over
-  the Host Message Queue mechanism. It exports also a debug interface.
- one library that ease the driver access from user-space
- a Python class that wrap the C library
- a set of command line tools to perform basic operations on the Mock Turtle
-  components
\ No newline at end of file
--- a/README.md
+++ b/README.md
+doc/README.md
\ No newline at end of file
--- a/doc/CHANGELOG
+++ b/doc/CHANGELOG
+# Change Log
+
+## [2.0] - 2016-06-08
+### Changed
+- Project change name to Mock Turtle. this means renaming all files
+  functions, data structures, enumerates and variables to a new
+  convention
+- port output real-time application to the real-time library
+- improve kernel driver performance
+### Added
+- unittest
+
+## [1.1] - 2015-10-20
+### Changed
+- minor changes in API behaviour on error
+
+## [1.0] - 2015-09-17
+
+- first release White Rabbit Node Core
+
+[2.0] http://www.ohwr.org/projects/wr-node-core-sw/repository/show?rev=mock-turtle-2.0
+[1.1] http://www.ohwr.org/projects/wr-node-core-sw/repository/show?rev=mock-turtle-1.1
+[1.0] http://www.ohwr.org/projects/wr-node-core-sw/repository/show?rev=mock-turtle-1.0
--- a/doc/CONTRIBUTING.md
+++ b/doc/CONTRIBUTING.md
+CODE
+====
+The projects use the following languages:
+- C for the driver, the user-space library and the embedded library
+- Python to export library functionality to Python
+
+RULES
+=====
+The master branch is protected so you need special permission to touch it.
+
+Do you development on your own branch and push it.
+
+In the project we are following the Linux kernel code style.
+
+All the functions, defines, structures, enumeraters exported should use
+the `trl_` prefix.
+
+All file names start with ''mockturtle-''
\ No newline at end of file
--- a/doc/LICENSE
+++ b/doc/LICENSE
--- a/doc/README.md
+++ b/doc/README.md
+Mock Turtle
+===========
+The project provide the software necessary to access Mock Turtle
+infrastructure on an FPGA.
+
+The software stack for the Mock Turtle is made of:
+- a driver that allow you to communication with the Mock Turtle CPUs over
+  the Host Message Queue mechanism. It exports also a debug interface.
+- one library that ease the driver access from user-space
+- a Python class that wrap the C library
+- a set of command line tools to perform basic operations on the Mock Turtle
+  components
\ No newline at end of file