aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rwxr-xr-xREADME38
1 files changed, 38 insertions, 0 deletions
diff --git a/README b/README
new file mode 100755
index 0000000..8dbe856
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
1# VoiceOfHangzhou
2
3A bot that catches Ingress comm messages and forwardes them to Telegram channel.
4
5## Dependencies
6
7+ *nix like OS, tested on Ubuntu
8
9+ Python3
10
11+ [Python-Telegram-Bot](https://github.com/python-telegram-bot/python-telegram-bot)
12
13+ selenium
14
15```bash
16sudo pip3 install selenium
17```
18
19+ [Phantomjs](http://phantomjs.org/)
20
21## Usage
22
23+ Make sure your OS support coresponding locales based on your comm range.
24
25e.g. zh_CN.UTF-8
26
27```bash
28sudo locale-gen zh_CN.UTF-8
29sudo dpkg-reconfigure locales
30```
31
32+ Copy `config.json.example` to `config.json` first, and remember to modify `config.json` and `PhantomjsPath` in `bot.py`
33
34To run, just type
35
36```bash
37python3 bot.py
38``` \ No newline at end of file
Powered by cgit v1.2.3 (git 2.41.0)