README.md: Remove sudo usage. 68/25968/5
authorVasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com>
Tue, 26 Jan 2021 01:23:52 +0000 (03:23 +0200)
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>
Fri, 5 Feb 2021 11:47:34 +0000 (11:47 +0000)
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>
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
-    $ 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: