* improve docs and add img.svg
This commit is contained in:
parent
1d3ceafe1f
commit
5dc9192977
4 changed files with 23 additions and 35 deletions
|
@ -10,7 +10,6 @@ Table of Contents
|
||||||
-----------------
|
-----------------
|
||||||
* Dependencies
|
* Dependencies
|
||||||
* Compliling The Project
|
* Compliling The Project
|
||||||
* Backporting to older version
|
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
------------
|
------------
|
||||||
|
@ -63,18 +62,3 @@ For BSD Users,
|
||||||
sudo pkg install mpv
|
sudo pkg install mpv
|
||||||
|
|
||||||
For Information about supported platforms read user.rst
|
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
|
|
||||||
|
|
25
doc/user.rst
25
doc/user.rst
|
@ -6,9 +6,8 @@ User Manual for PNimRP
|
||||||
Table Of Contents
|
Table Of Contents
|
||||||
-----------------
|
-----------------
|
||||||
* Supported Platforms
|
* Supported Platforms
|
||||||
* Controls
|
* Editing Links
|
||||||
* Links
|
* Editing Qoutes
|
||||||
* Qoutes
|
|
||||||
|
|
||||||
Supported Platforms
|
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
|
is not fully POSIX compiliant (some escape codes dont return the
|
||||||
desired result).
|
desired result).
|
||||||
|
|
||||||
Controls
|
Editing Links
|
||||||
--------
|
-------------
|
||||||
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 is just to look at the relevant file in assets directory.
|
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
|
the files are arranged in an json array and has to be even as it should
|
||||||
have name and link latter last respectively.
|
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::
|
.. 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
|
in assets directory
|
||||||
|
|
||||||
Qoutes
|
Editing Qoutes
|
||||||
------
|
--------------
|
||||||
you can edit qoutes in assets/qoute.json.
|
you can edit qoutes in assets/qoute.json.
|
||||||
- qoute first, author name second
|
- qoute first, author name second
|
||||||
- array should be even
|
- array should be even
|
||||||
|
|
1
img.svg
Normal file
1
img.svg
Normal file
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 232 KiB |
16
readme.rst
16
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
|
you can select through the radio stations and play, pause, mute, them
|
||||||
without ever getting your hands dirty touching on pls files.
|
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/user.rst for a basic level user usage documentation.
|
||||||
| see doc/installation.rst for installation instructions.
|
| see doc/installation.rst for installation instructions.
|
||||||
|
|
||||||
|
.. image:: img.svg
|
||||||
|
.. image:: ../img.svg
|
||||||
|
|
||||||
What we solve for you
|
What we solve for you
|
||||||
---------------------
|
---------------------
|
||||||
Disadvantages of pmrp::
|
Disadvantages of pmrp::
|
||||||
|
@ -41,10 +44,17 @@ then please install the `Nim compiler <https://nim-lang.org/install.html>`_
|
||||||
|
|
||||||
After installing the compiler run::
|
After installing the compiler run::
|
||||||
nimble install pnimrp
|
nimble install pnimrp
|
||||||
or to compile from here::
|
or to compile it afer cloning::
|
||||||
nim c pnimrp
|
nim c -d:release pnimrp
|
||||||
./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?
|
Do you want to readme(read me) in html?
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
documentation is written in RST so these can be viewed in a typical
|
documentation is written in RST so these can be viewed in a typical
|
||||||
|
|
Loading…
Reference in a new issue