Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KIDJourney committed Feb 26, 2016
1 parent 816e978 commit 6211a09
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,43 @@ There are still many unexcept situations unhandled , just a simple and crude dem
* Python3
* Requests module
* beautifulsoup4 module
* redis
* python redis module
* redis

Tested in only linux .
Tested in only *linux* .

## Install

After you satisfy the requirements .
Make sure your redis has default configure .

### Step 0
Clone the Repo .
```
$ git clone https://github.com/KIDJourney/TiebaManager
```
### Step 1
Edit config.ini to add your cookie and bar . Then
Edit ```config.example.ini``` to add your cookie and managed bar . Then
```
$ mv config.example.ini config.ini
```
### Step 2
```
$ python3 main.py
```
You can use ```Tmux``` or something similar to run it in backgroud .

## Judge Method

You can implement your own judge method in judgemethod.py or your own file .
Be Sure you class implement judge method of judgemethod.JudgeBase .
You can implement your own judge method in ```judgemethods.py``` .

The method is implemented as a function . Accept a ```Post``` object as argument .

Make sure you register your method with the ```__enable_method``` decorator.

## Warning

The Project is still in develop , some of code may be refactored frequently.

## Licenses
[Apache licenses](http://choosealicense.com/licenses/apache-2.0/)

0 comments on commit 6211a09

Please sign in to comment.