summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorVasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com>2021-01-26 03:23:52 +0200
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2021-02-05 11:47:34 +0000
commit5041bc36d6c399e304940b3703fd908998049669 (patch)
treefb5d548062a64cf5602d998664d23857ae2e5845 /README.md
parentd215d26262b9b00201de1525398c497c6ad9c94c (diff)
README.md: Remove sudo usage.
It is more common to use pip without sudo. Also, no reason to use sudo with 'mkdocs serve'. Bug-AGL: SPEC-3778 Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com> Change-Id: Ic4e2b34da98b0f036c34f253c0f0aeea150db443 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25968 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2d8df08..a14fcf6 100644
--- 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
- $ 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
- $ sudo mkdocs serve
+ $ mkdocs serve
```
Process to **add new or edit existing** markdown files to AGL documentation: