Update Readme and change format to ReStructured Text
This commit is contained in:
parent
a71e09d4a1
commit
e2793dfa83
15
README.md
15
README.md
|
@ -1,15 +0,0 @@
|
||||||
# i3Control
|
|
||||||
|
|
||||||
A basic android app that controls media functionality on my Linux PC.
|
|
||||||
This is the first version, so everything is hardcoded and messy.
|
|
||||||
|
|
||||||
## Android app
|
|
||||||
|
|
||||||
Just change the url to your backend in the `ApiService` class and build the app.
|
|
||||||
|
|
||||||
![App screenshot](https://i.imgur.com/0jrCoLl.png?1)
|
|
||||||
|
|
||||||
## Python backend
|
|
||||||
|
|
||||||
You can run it through wsgi or just directly from the shell using `python run.py`.
|
|
||||||
The only dependency is [Flask](https://pypi.python.org/pypi/Flask).
|
|
|
@ -0,0 +1,18 @@
|
||||||
|
i3Control
|
||||||
|
=========
|
||||||
|
|
||||||
|
A basic android app and python backend to control media functionality on Linux.
|
||||||
|
|
||||||
|
Android app
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Change the hostname or IP address of the target machine using the settings button top right.
|
||||||
|
|
||||||
|
.. image:: https://i.imgur.com/xQr2SDv.jpg
|
||||||
|
:alt: App screenshot
|
||||||
|
|
||||||
|
Python backend
|
||||||
|
--------------
|
||||||
|
|
||||||
|
You can run it through wsgi or just directly from the shell using ``python run.py``.
|
||||||
|
The only dependency is `Flask <https://pypi.python.org/pypi/Flask>`_.
|
Loading…
Reference in New Issue