Browse Source

Add basic README.md

Jonathan Golder 5 months ago
parent
commit
3ca9fb94ae
1 changed files with 30 additions and 0 deletions
  1. 30
    0
      README.md

+ 30
- 0
README.md View File

@@ -0,0 +1,30 @@
1
+# wiki-jogobot-teamstation
2
+This is a [Pywikibot](https://www.mediawiki.org/wiki/Manual:Pywikibot) based [Wikipedia Bot](https://de.wikipedia.org/wiki/Wikipedia:Bots)
3
+of [User:JogoBot](https://de.wikipedia.org/wiki/Benutzer:JogoBot) on the
4
+[German Wikipedia](https://de.wikipedia.org/wiki/Wikipedia:Hauptseite).
5
+
6
+It is used to correct errors in usage of [Template Team-Station](https://de.wikipedia.org/wiki/Vorlage:Team-Station).
7
+
8
+## Requirements
9
+* Python 3.4+ (at least it is only tested with those)
10
+* pywikibot-core 2.0
11
+* mwparserfromhell 0.5.1
12
+* [jogobot-core module](https://git.golderweb.de/wiki/jogobot) used as submodule
13
+
14
+## Usage
15
+```
16
+python teamstation.py -family:wikipedia
17
+```
18
+_Important_: Do not use `-always` since there are many special cases which are not detected. Always check diff!
19
+
20
+## Versions
21
+* v0.1 Semi-automatical correction of wrong dash symbols in time spans
22
+
23
+## Bugs
24
+[jogobot-teamstation Issues](https://git.golderweb.de/wiki/jogobot-teamstation/issues)
25
+
26
+## License
27
+GPLv3+
28
+
29
+## Author Information
30
+Copyright 2018 Jonathan Golder <jonathan@golderweb.de>