02_agl_compositor.md: How to change default ref UI

[AGL/documentation.git] / README.md

diff --git a/README.md b/README.md
index 045add8..a14fcf6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,20 @@
 # agl-docs (master)
-Revamping and restructuring Automotive Grade Linux's documentation site under GSoD'20.
-
--> [The working documentation site.](https://docs-agl.readthedocs.io)
-
--> [ReadTheDocs project page.](https://readthedocs.org/projects/docs-agl/)
-
-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-agl.readthedocs.io/en/latest/](https://docs-agl.readthedocs.io/en/latest/). The documentation site is hosted on [readthedocs](https://readthedocs.org/projects/docs-agl/) and corresponding builds are mentioned [here](https://readthedocs.org/projects/docs-agl/builds/).
+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/).
+The documentation site is hosted on
+[readthedocs](https://readthedocs.org/projects/automotivegradelinux/) and
+corresponding builds are mentioned
+[here](https://readthedocs.org/projects/automotivegradelinux/builds/).
 
 ## Download Repository
 
-Kindly check [this](https://wiki.automotivelinux.org/agl-distro/contributing) and clone with commit-msg hook :
+Kindly check [this](https://wiki.automotivelinux.org/agl-distro/contributing)
+and clone with commit-msg hook :
 
 ```sh
 $ git clone "ssh://$USER@gerrit.automotivelinux.org:29418/AGL/documentation" && scp -p -P 29418 $USER@gerrit.automotivelinux.org:hooks/commit-msg "documentation/.git/hooks/"
@@ -26,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:
@@ -73,7 +82,8 @@ documentation
 
 ## Test Hyperlinks
 
-[LinkChecker](https://wummel.github.io/linkchecker/) is a tool that allows to check all the hyperlinks in the site.
+[LinkChecker](https://wummel.github.io/linkchecker/) is a tool that allows to
+check all the hyperlinks in the site.
 
 For testing hyperlinks as soon as the local site is running, do:
 
@@ -81,8 +91,8 @@ For testing hyperlinks as soon as the local site is running, do:
 linkchecker http://localhost:8000
 ```
 
-The ```linkchecker``` output will display the broken link and there location
-in the site.
+The ```linkchecker``` output will display the broken link and there location in
+the site.
 
 
 ## Submitting changes