summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 803cfcbe5cc06b1ffd67077dedb0c56b23051b10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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```