aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJinwei Zhao <[email protected]>2016-11-15 20:15:47 +0800
committerJinwei Zhao <[email protected]>2016-11-15 20:15:47 +0800
commitf5af8e73a17b814ad2feb53891f064769b81750e (patch)
treef48a6395abde127731831e15fc10b58360bf1249 /README.md
parentb343c5950c57c04c8702bc3841febb083166208f (diff)
downloadLumberJack-f5af8e73a17b814ad2feb53891f064769b81750e.tar.gz
add README
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index 53abc57..2cef45a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,30 @@
1# LumberJack bot [![CircleCI](https://circleci.com/gh/clarkzjw/LumberJack.svg?style=svg)](https://circleci.com/gh/clarkzjw/LumberJack) 1# LumberJack bot [![CircleCI](https://circleci.com/gh/clarkzjw/LumberJack.svg?style=svg)](https://circleci.com/gh/clarkzjw/LumberJack)
2
3## Usage
4
5```python
6python3 bot.py
7```
8
9Make sure you have PyAutoGUI installed.
10
11If you use Debian based Linux, you can install PyAutoGUI by
12
13```bash
14sudo apt-get install scrot python3-tk python3 python3-dev python3-pip
15sudo pip3 install image
16sudo pip3 install python3-xlib
17sudo pip3 install pyautogui
18```
19
20## The Docker way
21
22Although the Docker image of this bot cannot work correctly, you can give it a try. Remember to read the comments on top of Dockerfile
23
24```bash
25docker run -it \
26-e DISPLAY=$DISPLAY \
27-v /tmp/.X11-unix:/tmp/.X11-unix \
28clarkzjw/lumberjack
29```
30
Powered by cgit v1.2.3 (git 2.41.0)