Fixing SSH key generation problem

[AGL/documentation.git] / README.md

diff --git a/README.md b/README.md
index 2d8df08..66e22b2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
-# agl-docs (master)
+# agl-docs (needlefish)
 Revamping and restructuring Automotive Grade Linux's documentation site under
 GSoD'20.
 
 The [documentation gerrit
 repository](https://gerrit.automotivelinux.org/gerrit/admin/repos/AGL/documentation)
 contains AGL documentation website template and content, rendering is visible at
-[https://docs.automotivelinux.org/en/master/](hhttps://docs.automotivelinux.org/en/master/).
+[https://docs.automotivelinux.org/en/needlefish/](hhttps://docs.automotivelinux.org/en/needlefish/).
 The documentation site is hosted on
 [readthedocs](https://readthedocs.org/projects/automotivegradelinux/) and
 corresponding builds are mentioned
@@ -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: