diff --git a/README.md b/README.md new file mode 100644 index 00000000..b33c4eab --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# phoenix-rtos-doc + +The full documentation can be found on . + +This repository contains all the necessary files needed to build +Phoenix-RTOS Documentation using [https://github.com/sphinx-doc/sphinx](sphinx). + +It can be done using the following command: + +```console +make clean html +``` + +The artifacts will be available in `_build` directory.