diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..803cfcb --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# agl-docs (master) +Revamping and restructuring Automotive Grade Linux's documentation site under GSoD'20. + +-> [The working documentation site.](https://agl-docs.readthedocs.io) + +-> [ReadTheDocs project page.](https://readthedocs.org/projects/agl-docs/) + +## To setup local build environment : + +1) Clone this Repository : ```git clone https://github.com/growupboron/agl-docs.git``` + +2) Change into the directory : ```cd agl-docs/``` + +3) Install MkDocs and rtd-dropdown theme : ```sudo pip3 install -r requirements.txt``` + +4) Serve it, it would get defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/) : ```sudo mkdocs serve``` + + |