Skip to content

Commit

Permalink
[upd] README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tomsimonart committed May 9, 2018
1 parent 19ee811 commit f0e610e
Showing 1 changed file with 44 additions and 14 deletions.
58 changes: 44 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,53 @@
# Guide
---
## Installation
* Clone this repository then get into its directory
>```cd ./GLM-web-interface```
* edit .git/config if don't have the repository rights. Change this line:
> ```url = git@github.com:tomsimonart/GLM.git```
* Clone :

with
> ```url = https://github.com/tomsimonart/GLM.git```
* Install submodules
>```git submodule update --recursive```
>```cd ./GLM-web-interface```
* Install python packages (**Using "**virtualenv**" is recommended**) :

>```pip install -r requirements.txt```
> You also have to install **TKinter** (for the guishow feature)
* Upload the arduino sketch (tested with **arduino uno**):

> You can for example use the **Arduino IDE** or **PlatformIO**
> The sketch is located in ***LMPM/GLM/matrix_IO/matrix_IO.ino***
## Starting
* Install python packages (**Using "**virtualenv**" is recommended**)
>```pip install -r requirements.txt```
* Start flask
>```source launch.sh```

>```flask run```
* Start the server :

>```./lmpm_server```
the available arguments can be found with :

>```./lmpm_server -h```
some examples :

>```./lmpm_server -vvv```
>```./lmpm_server -s```
>```./lmpm_server -V check -V info -m```

* Start flask (when the server is running only)

>```source launch.sh```
>```flask run```
## Web
* Url should be **[http://localhost:5000](http://localhost:5000)**
* Url should be

> **[http://localhost:5000](http://localhost:5000)**
#### Special thanks
* **Maribib** for his more than great help with the server
* **Mino** for the guishow feature and for making this project happen
* **Etnarek** and **iTitou** for their help with the arduino code

0 comments on commit f0e610e

Please sign in to comment.