pnimrp/doc/user.rst

48 lines
1.2 KiB
ReStructuredText

======================
User Manual for PNimRP
======================
.. include:: rstcommon.rst
Table Of Contents
-----------------
* Supported Platforms
* Editing Links
* Editing Qoutes
Supported Platforms
-------------------
Ceiling of supportiveness boils down to the usage of mpv api used
to play streams, and not because of the application code, thus can
be extended in the future.
Supported platforms include but not limited to:
- Working
* Windows 7+
* MacOS
* Linux 3.2+
* BSDs
* OpenSolaris-based
DragonFlyBSD is not currently supported as the tty implementation
is not fully POSIX compiliant (some escape codes dont return the
desired result).
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.
.. note::
explicitly adding https:// will make sure it retrives https data
.. note::
should not specify http to reduce too much duplicate text
in assets directory
Editing Qoutes
--------------
you can edit qoutes in assets/qoute.json.
- qoute first, author name second
- array should be even