Add documentation

Signed-off-by: Costin Lupu <costin.lupu@cs.pub.ro>
Reviewed-by: Florian Schmidt <florian.schmidt@neclab.eu>

diff --git a/CODING_STYLE.md b/CODING_STYLE.md
new file mode 100644 (file)
index 0000000..5730041
--- /dev/null
+++ b/CODING_STYLE.md
@@ -0,0 +1,4 @@
+Coding Style
+============
+
+Please refer to the `CODING_STYLE.md` file in the main Unikraft repository.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..5f55eca
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,4 @@
+Contributing to Unikraft
+=======================
+
+Please refer to the `CONTRIBUTING.md` file in the main Unikraft repository.

diff --git a/COPYING.md b/COPYING.md
new file mode 100644 (file)
index 0000000..19855c2
--- /dev/null
+++ b/COPYING.md
@@ -0,0 +1,30 @@
+License
+=======
+
+Unikraft pthread-embedded wrappers
+----------------------------------
+
+This repository contains wrapper code to build pthread-embedded with Unikraft.
+Each C code file in this repository should declare who is the
+copyright owner and under which terms and conditions the code is
+licensed. If such a licence note is missing, the following copyright
+notice will apply:
+
+
+       Copyright(C) Year Name, Institution
+       
+       This library is free software; you can redistribute it and/or
+       modify it under the terms of the GNU Lesser General Public
+       License as published by the Free Software Foundation; either
+       version 2 of the License, or (at your option) any later version.
+       
+       This library is distributed in the hope that it will be useful,
+       but WITHOUT ANY WARRANTY; without even the implied warranty of
+       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+       Lesser General Public License for more details.
+       
+       You should have received a copy of the GNU Lesser General Public
+       License along with this library in the file COPYING.LIB;
+       if not, write to the Free Software Foundation, Inc.,
+       59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
new file mode 100644 (file)
index 0000000..ceadfce
--- /dev/null
+++ b/MAINTAINERS.md
@@ -0,0 +1,10 @@
+Maintainers List
+================
+
+For notes on how to read this information, please refer to `MAINTAINERS.md` in
+the main Unikraft repository.
+
+       PTHREAD-EMBEDDED-UNIKRAFT
+       M:      Costin Lupu <costin.lupu@cs.pub.ro>
+       L:      minios-devel@lists.xen.org
+       F: *

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..2ecc239
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+pthread-embedded for Unikraft
+=============================
+
+Please refer to the `README.md` as well as the documentation in the `doc/`
+subdirectory of the main unikraft repository.