readme build usage

This commit is contained in:
arnaucode
2017-06-02 09:47:54 +02:00
parent 3c1f3d7a62
commit 4beff6fbd0

31
build/README.md Normal file
View File

@@ -0,0 +1,31 @@
# Argos
## How to use
### Linux
Download the file **argos**
needs a **twitterConfig.json** file on the **/build** or the folder where is placed **argos** file, with the content:
```
{
"consumer_key": "xxxxxxxxxxxxxxxx",
"consumer_secret": "xxxxxxxxxxxxxxxx",
"access_token_key": "xxxxxxxxxxxxxxxx",
"access_token_secret": "xxxxxxxxxxxxxxxx"
}
```
The tokens and keys, need to be obtained from twitter apps page: https://apps.twitter.com
To run it:
- go to the **/build** folder or the folder where is placed **argos** file
- open terminal
- execute the script with:
```
./argos
```
- follow the instructions that appears on the terminal