From 48018abdea28a7985083f8cd3b980dfc95bb3505 Mon Sep 17 00:00:00 2001 From: nivong Date: Thu, 11 Aug 2016 09:41:52 +0200 Subject: [PATCH 1/6] Made the READ me more read friendly and compactor. --- README.md | 33 +++++++-------------------------- 1 file changed, 7 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index d372870ca6..3ae530c6db 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,13 @@ - -# PokemonGo-Bot (Working) +# PokemonGo-Bot PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team. -The project is currently setup in two main branches. `dev` and `master`. - -## Help Needed on [Desktop Version](https://github.com/PokemonGoF/PokemonGo-Bot-Desktop) +The project is currently setup in two main branches. `dev` and `master`. Submit your PR's to `dev`. -## Please submit PR to [Dev branch](https://github.com/PokemonGoF/PokemonGo-Bot/tree/dev) - -We use [Slack](https://slack.com) as a web chat. [Click here to join the chat!](https://pokemongo-bot.herokuapp.com) -You can count on the community in #help channel. +If you need any help please don't create an issue here on github we have a great community on [Slack](https://slack.com) [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel. ## Table of Contents +- [Installation] (https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md) - [Features](#features) -- [Wiki](#wiki) +- [Wiki](https://github.com/PokemonGoF/PokemonGo-Bot/wiki) - [Credits](#credits) ## Features @@ -27,9 +22,9 @@ You can count on the community in #help channel. - [x] Rudimentary IV Functionality filter - [x] Ignore certain pokemon filter - [x] Adjust delay between Pokemon capture & Transfer as per configuration -- [ ] Standalone Desktop Application - [x] Hatch eggs - [x] Incubate eggs +- [ ] [Standalone Desktop Application] (https://github.com/PokemonGoF/PokemonGo-Bot-Desktop) - [ ] Use candy - [ ] Inventory cleaner @@ -45,22 +40,8 @@ If there are any concerns with this policy or you believe we are tracking someth If you do not want any data to be gathered, you can turn off this feature by setting `health_record` to `false` in your `config.json`. -## Wiki -All information on [Getting Started](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Getting-Started) is available in the [Wiki](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/)! -- __Installation__ - - [Requirements] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#requirements-click-each-one-for-install-guide) - - [How to run with Docker](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/How-to-run-with-Docker) - - [Linux] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-linux) - - [Mac] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-mac) - - [Windows] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-windows) -- [Develop PokemonGo-Bot](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Develop-PokemonGo-Bot) -- [Plugins](https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/plugins.md) -- [Configuration-files](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Configuration-files) -- [Front end web module - Google Maps API] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Google-Maps-API-(web-page)) -- [Docker Usage](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/FAQ#how-to-run-with-docker) -- [FAQ](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/FAQ) +## Help Needed on [Desktop Version](https://github.com/PokemonGoF/PokemonGo-Bot-Desktop) -To ensure that all updates are documented - [@eggins](https://github.com/eggins) will keep the Wiki updated with the latest information on installing, updating and configuring the bot. ## Credits - [tejado](https://github.com/tejado) many thanks for the API From 7037ccf5a7d39192d27772f58585f5d15b07fed7 Mon Sep 17 00:00:00 2001 From: nivong Date: Thu, 11 Aug 2016 09:42:47 +0200 Subject: [PATCH 2/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ae530c6db..ac6d56eea4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team. The project is currently setup in two main branches. `dev` and `master`. Submit your PR's to `dev`. -If you need any help please don't create an issue here on github we have a great community on [Slack](https://slack.com) [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel. +If you need any help please don't create an issue here on github we have a great community on Slack, [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel. ## Table of Contents - [Installation] (https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md) From 9d5bed46ba5e32ef90e0269df01ea27ec400d2eb Mon Sep 17 00:00:00 2001 From: nivong Date: Thu, 11 Aug 2016 09:43:25 +0200 Subject: [PATCH 3/6] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index ac6d56eea4..f024024b74 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # PokemonGo-Bot PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team. The project is currently setup in two main branches. `dev` and `master`. Submit your PR's to `dev`. - If you need any help please don't create an issue here on github we have a great community on Slack, [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel. ## Table of Contents From 9de2deba446807b4670324909a8c97110dbcc957 Mon Sep 17 00:00:00 2001 From: nivong Date: Thu, 11 Aug 2016 09:43:40 +0200 Subject: [PATCH 4/6] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f024024b74..c4448dc018 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # PokemonGo-Bot PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team. + The project is currently setup in two main branches. `dev` and `master`. Submit your PR's to `dev`. + If you need any help please don't create an issue here on github we have a great community on Slack, [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel. ## Table of Contents From a89dbcc9f0bde707ea5c1802f4de919d042aa1e6 Mon Sep 17 00:00:00 2001 From: nivong Date: Thu, 11 Aug 2016 09:44:24 +0200 Subject: [PATCH 5/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c4448dc018..d2172efbb2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # PokemonGo-Bot PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team. -The project is currently setup in two main branches. `dev` and `master`. Submit your PR's to `dev`. +The project is currently setup in two main branches. `dev` also known as `beta` and `master` also known as `stable`. Submit your PR's to `dev`. If you need any help please don't create an issue here on github we have a great community on Slack, [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel. From 2f78c68f04ad983653ac29c4bfbb447b436aedf5 Mon Sep 17 00:00:00 2001 From: nivong Date: Thu, 11 Aug 2016 09:47:18 +0200 Subject: [PATCH 6/6] Update faq.md --- docs/faq.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 7720f0a64c..ba2524bbce 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,7 +1,12 @@ ### How do I start the application? -After customizing your config.json files, cd to the PokemonGo-Bot folder and enter: +After [installing] (https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md), in the root folder run the following command: +### Linux ``` -$ python pokecli.py +run.sh +``` +### Windows +``` +run.bat ``` This will start the application.