diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6e31b1673cd32998be28a23dc8b14aafc6a3c980 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# The main documentation + +This is the repository of [the main documentation of Startin'blox](https://docs.startinblox.com/). + +We use [Sphinx](https://www.sphinx-doc.org/en/master/) to manage the documentation and we use [Restructured Text](https://docutils.sourceforge.io/rst.html) to write it. + + +## How to update it + +Clone the repository +Find the file use when to update +Make a Merge Request :) + +## You get trouble ? + +If you have any difficulties or feedbacks, we'll be pleased to improve the doc thanks to your contribution ! + +Contact the maintainer : alice@startinblox.com + +Thanks! \ No newline at end of file