From e2793dfa832cc120a991e2128882b23a0dedc204 Mon Sep 17 00:00:00 2001 From: Pavle Portic Date: Fri, 13 Apr 2018 03:14:42 +0200 Subject: [PATCH] Update Readme and change format to ReStructured Text --- README.md | 15 --------------- README.rst | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 15 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index a3d1f1e..0000000 --- a/README.md +++ /dev/null @@ -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). diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..35ba9bc --- /dev/null +++ b/README.rst @@ -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 `_.