commit 0e6d4feefa0c47785ca26157bf003c323b75dc29
parent 866ec1f213cbddacda438992eeefac329f9949a9
Author: Antoine Amarilli <a3nm@a3nm.net>
Date: Mon, 11 Jun 2012 20:02:27 +0200
add mit license and section headings
Diffstat:
| README | | | 27 | +++++++++++++++++++++++++++ |
1 file changed, 27 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -1,12 +1,37 @@
wikifirc -- filter irc.wikimedia.org on specific pages and users
Copyright (C) 2012 by Antoine Amarilli
+== 0. License (MIT license) ==
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== 1. Description ==
+
wikifirc is a tool to filter changes from irc.wikimedia.org on specific pages
and users. All events on followed pages, all events by followed users, and all
events on followed users' user and user talk pages are kept and the rest is
discarded; besides, when a followed user edits a page, the page becomes
followed.
+== 2. How to use ==
+
Run as wikifirc ADMIN [DUMP]. DUMP is a file that will be read at startup to
populate the list of followed users and pages. ADMIN should be the nick of the
program administrator or irc.wikimedia.org. Events from irc.wikimedia.org should
@@ -39,6 +64,8 @@ are read from pagelist at startup and written to pagelist on exit) and pipes it
to your own IRC server. The bot can be controlled by /msg'ing uniquebotnick as
adminnick on irc.wikimedia.org.
+== 3. Hacking ==
+
A few things can easily be tweaked in the code:
- add support for different languages
