From ca2cdf5c89977ca44a4ac2b5edb46d2dcdb55fab Mon Sep 17 00:00:00 2001 From: Jinwei Zhao Date: Mon, 2 Jan 2017 22:14:55 +0800 Subject: update README --- README | 38 -------------------------------------- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 38 deletions(-) delete mode 100755 README create mode 100755 README.md diff --git a/README b/README deleted file mode 100755 index 8dbe856..0000000 --- a/README +++ /dev/null @@ -1,38 +0,0 @@ -# VoiceOfHangzhou - -A bot that catches Ingress comm messages and forwardes them to Telegram channel. - -## Dependencies - -+ *nix like OS, tested on Ubuntu - -+ Python3 - -+ [Python-Telegram-Bot](https://github.com/python-telegram-bot/python-telegram-bot) - -+ selenium - -```bash -sudo pip3 install selenium -``` - -+ [Phantomjs](http://phantomjs.org/) - -## Usage - -+ Make sure your OS support coresponding locales based on your comm range. - -e.g. zh_CN.UTF-8 - -```bash -sudo locale-gen zh_CN.UTF-8 -sudo dpkg-reconfigure locales -``` - -+ Copy `config.json.example` to `config.json` first, and remember to modify `config.json` and `PhantomjsPath` in `bot.py` - -To run, just type - -```bash -python3 bot.py -``` \ No newline at end of file diff --git a/README.md b/README.md new file mode 100755 index 0000000..8dbe856 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# VoiceOfHangzhou + +A bot that catches Ingress comm messages and forwardes them to Telegram channel. + +## Dependencies + ++ *nix like OS, tested on Ubuntu + ++ Python3 + ++ [Python-Telegram-Bot](https://github.com/python-telegram-bot/python-telegram-bot) + ++ selenium + +```bash +sudo pip3 install selenium +``` + ++ [Phantomjs](http://phantomjs.org/) + +## Usage + ++ Make sure your OS support coresponding locales based on your comm range. + +e.g. zh_CN.UTF-8 + +```bash +sudo locale-gen zh_CN.UTF-8 +sudo dpkg-reconfigure locales +``` + ++ Copy `config.json.example` to `config.json` first, and remember to modify `config.json` and `PhantomjsPath` in `bot.py` + +To run, just type + +```bash +python3 bot.py +``` \ No newline at end of file -- cgit v1.2.3