typos
authorTobias Diekershoff <tobias.diekershoff@gmx.net>
Sun, 4 Oct 2020 18:27:27 +0000 (20:27 +0200)
committerTobias Diekershoff <tobias.diekershoff@gmx.net>
Sun, 4 Oct 2020 18:27:27 +0000 (20:27 +0200)
doc/README.md [new file with mode: 0644]

diff --git a/doc/README.md b/doc/README.md
new file mode 100644 (file)
index 0000000..12aa89f
--- /dev/null
@@ -0,0 +1,19 @@
+# About the docs of the Friendica Project
+
+## User and Admin documentation
+
+Every Friendica node has the _current_ version of the user and admin documentation avail-able in the `/help` location.
+The documentation is mainly done in English, but the pages are translate able and some are already translated to German.
+If you want to help expanding the documentation or the translation, please register an account at the [Friendica wiki](https://wiki.friendi.ca) where the [texts are maintained](https://wiki.friendi.ca/docs).
+The documentation is periodically merged back from there to the _development_ branch of Friendica.
+
+Images that you use in the documentation should be located in the `img` sub-directory of this directory.
+Translations are located in sub-directories named after the language codes, e.g. `de`.
+Depending on the selected interface language the different translations will be applied, or the `en` original will be used as a fall-back.
+
+## Developers Documentation
+
+We provide a configuration file for [Doxygen](https://www.doxygen.nl/index.html) in the root of the Friendica repository.
+With that you should be able to extract some documentation from the source code.
+
+In addition there are some documentation files about the database structure in `doc`db`.