Code Review
/
AGL
/
documentation.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Document deprecated demo images
[AGL/documentation.git]
/
README.md
diff --git
a/README.md
b/README.md
index
2d8df08
..
a14fcf6
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-31,13
+31,17
@@
$ git clone "ssh://$USER@gerrit.automotivelinux.org:29418/AGL/documentation" &&
2. Install MkDocs and rtd-dropdown theme
```sh
2. Install MkDocs and rtd-dropdown theme
```sh
- $
sudo
pip install -r requirements.txt
+ $ pip install -r requirements.txt
```
```
+ Missing packages will be installed for the current user, in particular,
+ scripts will be installed to `$HOME/.local/bin`. Ensure `$HOME/.local/bin` is
+ in your `PATH` to be able to run `mkdocs` command.
+
3. Serve locally (defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/)):
```sh
3. Serve locally (defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/)):
```sh
- $
sudo
mkdocs serve
+ $ mkdocs serve
```
Process to **add new or edit existing** markdown files to AGL documentation:
```
Process to **add new or edit existing** markdown files to AGL documentation: