* improve docs and add img.svg

doc/installation.rst

@@ -10,7 +10,6 @@ Table of Contents
 -----------------
   * Dependencies
   * Compliling The Project
-  * Backporting to older version
 
 Dependencies
 ------------
@@ -63,18 +62,3 @@ For BSD Users,
    sudo pkg install mpv
 
 For Information about supported platforms read user.rst
-
-Compiling The Project
----------------------
-Compilation is as simple as running this command at root project folder,
-and is the same regardless the platform.
-
-Using Nimble Package Manager::
-  nimble build
-  nimble install
-
-Using Compiler Directly::
-  nim c -d:release pnimrp
-
-Note:
- * project does not compile under JS backend

doc/user.rst

@@ -6,9 +6,8 @@ User Manual for PNimRP
 Table Of Contents
 -----------------
   * Supported Platforms
-  * Controls
-  * Links
-  * Qoutes
+  * Editing Links
+  * Editing Qoutes
 
 Supported Platforms
 -------------------
@@ -28,27 +27,21 @@ DragonFlyBSD is not currently supported as the tty implementation
 is not fully POSIX compiliant (some escape codes dont return the
 desired result).
 
-Controls
---------
-General Controls are using given numbers or characters to select
-the menu. where R would return and q would quit out of the
-application. and when stream is being played, use p to pause,
-m to mute, + to volume up and - to volume down.
-
-Links
------
+Editing Links
+-------------
 Editing Links is just to look at the relevant file in assets directory.
 the files are arranged in an json array and has to be even as it should
 have name and link latter last respectively.
 
-explicitly adding  https:// will make sure it retrives https data
+.. note::
+  explicitly adding  https:// will make sure it retrives https data
 
 .. note::
-  cannot specify http or https because its too much duplicate text
+  should not specify http to reduce too much duplicate text
   in assets directory
 
-Qoutes
-------
+Editing Qoutes
+--------------
 you can edit qoutes in assets/qoute.json.
 - qoute first, author name second
 - array should be even

readme.rst

@@ -9,11 +9,14 @@ with the collection of 30+ modifiable radio station link files (json)
 you can select through the radio stations and play, pause, mute, them
 without ever getting your hands dirty touching on pls files.
 
-bleesed with the inspiration from `Poor Man's radio player <https://github.com/hakerdefo/pmrp>`_
+blessed with the inspiration from `Poor Man's radio player <https://github.com/hakerdefo/pmrp>`_
 
 | see doc/user.rst for a basic level user usage documentation.
 | see doc/installation.rst for installation instructions.
 
+.. image:: img.svg
+.. image:: ../img.svg
+
 What we solve for you
 ---------------------
 Disadvantages of pmrp::
@@ -41,10 +44,17 @@ then please install the `Nim compiler <https://nim-lang.org/install.html>`_
 
 After installing the compiler run::
   nimble install pnimrp
-or to compile from here::
-  nim c pnimrp
+or to compile it afer cloning::
+  nim c -d:release pnimrp
   ./pnimrp
 
+In-Player Controls
+------------------
+General Controls are using given numbers or characters to select
+the menu. where R would return and q would quit out of the
+application. and when stream is being played, use p to pause,
+m to mute, + to volume up and - to volume down.
+
 Do you want to readme(read me) in html?
 ---------------------------------------
 documentation is written in RST so these can be viewed in a typical