Commit ed75ac69 authored by hackEns's avatar hackEns
Browse files

Rename jarvis_bot to jarvis

parent ef8808e9
......@@ -15,7 +15,7 @@ Jarvis can be easily installed on a Raspberry Pi, starting from an up-to-date Ra
5. Copy `config.py.example` to `config.py` and then edit it. All items should be self-explicit.
6. Make sure your user is member of the `gpio` and `video` groups.
7. Jarvis does not automatically export the GPIO pins to prevent it from running as `root`. So you should `gpio export PIN out` for the pins you use (1 and 7 by defautl).
7. Run `jarvis_bot.py` to start Jarvis.
7. Run `jarvis.py` to start Jarvis.
*Note :* Jarvis requires a MySQL database to be used, and a webserver to serve the web visualisation (repo [Jarvis web](https://github.com/hackEns/Jarvis_web)). As our webserver does not run on the Raspberry Pi, the above scripts do not include the setup for the webserver and the MySQL database. You should install and set them yourself. `system/jarvis.sql` contains all the necessary information to setup the database and tables.
......@@ -27,7 +27,7 @@ Jarvis can be easily installed on a Raspberry Pi, starting from an up-to-date Ra
* `aziz.py` is our moderation script, to inform us of new emails waiting for moderation. It's basically a Jarvis plugin.
* `data` folder contains the scripts, aliases etc you put into Jarvis.
* `jarvis.all.log` (created by Jarvis) is the complete log of the watched channel.
* `jarvis_bot.py` is the main script, which serves the bot.
* `jarvis.py` is the main script, which serves the bot.
* `jarvis_cmd.py` is a collection of functions to translate Jarvis actions to GPIO actions etc.
* `Rules` contains a set of scripts for the various Jarvis actions.
* `STL export` contains 3D models for our setup.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment