Initial commit

1 files changed, 41 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d026801
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+<!---
+Copyright 2019 Robin Krahl <robin.krahl@ireas.org>
+SPDX-License-Identifier: CC0-1.0
+-->
+
+# ntw
+
+`ntw` is an experimental firmware for the Nitrokey Pro.  It is in very early
+development and currently does not support any commands.
+
+## Resources
+
+### Development Setup
+
+- NUCLEO-F103RB: [data sheet][NUCLEO-F103RB-ds]
+- XNUCLEO-F103RB: [Waveshare wiki][XNUCLEO-F103RB-wiki]
+- STM32F103RB: [data sheet][STM32F103RB-ds], [reference manual][STM32F103RB-rm]
+
+[NUCLEO-F103RB-ds]: https://www.st.com/resource/en/data_brief/nucleo-f103rb.pdf
+[XNUCLEO-F103RB-wiki]: https://www.waveshare.com/wiki/XNUCLEO-F103RB
+[STM32F103RB-ds]: https://www.st.com/resource/en/datasheet/stm32f103rb.pdf
+[STM32F103RB-rm]: https://www.st.com/content/ccc/resource/technical/document/reference_manual/59/b9/ba/7f/11/af/43/d5/CD00171190.pdf/files/CD00171190.pdf/jcr:content/translations/en.CD00171190.pdf
+
+## Contact
+
+For bug reports, patches, feature requests or other messages, please send a
+mail to [ntw-dev@ireas.org][].
+
+## License
+
+This project is licensed under the [GNU General Public License version 3][GPL]
+or later.  The documentation and configuration files contained in this
+repository are licensed under the [Creative Commons Zero][CC0] license.  You
+can find a copy of the license texts in the `LICENSES` directory.
+
+`ntw` complies with [version 2.0 of the REUSE practices][reuse].
+
+[ntw-dev@ireas.org]: mailto:ntw-dev@ireas.org
+[GPL]: https://www.gnu.org/licenses/gpl-3.0.en.html
+[CC0]: https://creativecommons.org/publicdomain/zero/1.0/
+[reuse]: https://reuse.software/practices/2.0/