Skip to content

Commit

Permalink
More documentation changes making it noob proof(er) (#3575)
Browse files Browse the repository at this point in the history
* added information on what what does

* add a link to the docker hub for NAS users.
  • Loading branch information
nivong authored and elicwhite committed Aug 11, 2016
1 parent de09f34 commit 9623133
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
10 changes: 9 additions & 1 deletion docs/docker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
Start by downloading for your platform: [Mac](https://www.docker.com/products/docker#/mac), [Windows](https://www.docker.com/products/docker#/windows), or [Linux](https://www.docker.com/products/docker#/linux). Once you have Docker installed, simply create the various config.json files for your different accounts (e.g. `configs/config-account1.json`) and then create a Docker image for PokemonGo-Bot using the Dockerfile in this repo.
Start by downloading for your platform: [Mac](https://www.docker.com/products/docker#/mac), [Windows](https://www.docker.com/products/docker#/windows), or [Linux](https://www.docker.com/products/docker#/linux). Once you have Docker installed, simply create the various config.json files for your different accounts (e.g. `configs/config-account1.json`) and then create a Docker image for PokemonGo-Bot using the Dockerfile in this [repo](https://hub.docker.com/r/svlentink/pokemongo-bot/).

#Automatic setup
Use this docker hub url: https://hub.docker.com/r/svlentink/pokemongo-bot/
```
docker pull svlentink/pokemongo-bot
```

#Manual setup
```
cd PokemonGo-Bot
docker build -t pokemongo-bot .
Expand Down
14 changes: 11 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,22 @@
- [protobuf 3](https://github.com/google/protobuf) (OS Dependent, see below)

#Linux/Mac Automatic installation
### Easy installation (automatic, linux only)
### Easy installation
1. Run setup.sh -e
This will create the needed encrypted.so file
2. Run setup.sh -i
This will install the bot and all stuff that is needed to run it (follow the guide)
3. Run setup.sh -c
This will make the config file needed, only basic stuff is changed here. If you want to edit more edit this file after: config/config.json
4. Run run.sh
This will run the bot and will start leveling your pokemon go account.

### To update
1. Run setup.sh -r
2. Run setup.sh -u
1. Stop the bot if it's running. (use control + c twice to stop it)
2. Run setup.sh -r
This will reset and makes sure you have no changes made to any code since it will overide it
3. Run setup.sh -u
This will run git pull and will update to the new git update.


# Manual installation
Expand Down

0 comments on commit 9623133

Please sign in to comment.