From 1072a896ef59cd2bd4372d2f03545ea98edb7d7b Mon Sep 17 00:00:00 2001 From: gry <guppy@123mail.org> Date: Thu, 26 May 2011 19:26:25 +0930 Subject: [PATCH] INSTALL cleanup; documentation @ website --- INSTALL | 40 ++++------------------------------------ README | 24 ------------------------ TODO | 18 ++++++++++-------- docs/modules | 4 ---- 4 files changed, 14 insertions(+), 72 deletions(-) delete mode 100644 docs/modules diff --git a/INSTALL b/INSTALL index baa363f..f2e7545 100644 --- a/INSTALL +++ b/INSTALL @@ -1,37 +1,5 @@ -OS Support - -- Linux (tested) -- Mac OS X -- Others - -Requirements - -- Python 2.5.2 or later -- argparse module (in P.2.7+) -- No support for Python 3 yet! - -Install - - ./guppy-start - Answer questions. - ./guppy-start - -Interface - - Type the comchar in a channel the bot is in to see the list of loaded modules. - - The comchar followed by a module name or a command name displays the list of - commands in the module or its help text. - - guppy supports multiple comchars, which you need to list in the config file in - the proper order. If a match to one of them is found, we do not check the - rest. This is why you need to put 'nick: ' before 'nick:' if you want to - address the bot by both. An example setting is - - - -|nick: |nick:|nick, |nick,|nick |nick - - - Then you can address the bot by -, nick: (with or without space), nick - (with or without space), nick (with or without space). +1.) ./guppy-start +2.) Answer questions. +3.) ./guppy-start (in background) +Read more: http://www.guppy-project.org/doku.php?id=install_guide diff --git a/README b/README index 2faf97c..90a7d6f 100644 --- a/README +++ b/README @@ -1,33 +1,9 @@ guppy is a modular IRC bot. The API makes new modules easier to add.. The project is in beta. -== Features == - - [admin] Keep a list of bot users and passwords. Bot administrators can send -raw commands to server and add other administrators. - [fact] Keep a list of factoids. Everyone can change them. The dictionary is -located at ~/.guppy/dict . - [calc] Perform basic calculations on a Reverse Polish Notation Input. Should -be enough for most operations needed. The implementation is pretty - straightforward and secure; eval() isn't used. - [--makeconf] Keep a configuration file at ~/.guppy/main.cfg . It's created -basing on your answers on first run, and you can run gpy-start with the ---makeconf switch to edit the current configuration. - Logs. Keep a log of queries to the bot and any errors encountered. - [web] Perform some web functions - Google translate - Google web search - duckduckgo.com infoboxes search - dns lookup - youtube video information lookup by URL or id - -== Files == - INSTALL - how to install - docs/ - how stuff works TODO - planned features -== Note == You can contribute. I will review any patches and add changes upstream within reasonable amounts of time. diff --git a/TODO b/TODO index 2961716..ef85984 100644 --- a/TODO +++ b/TODO @@ -8,15 +8,17 @@ Milestone: 0.4 [ ] add admin' module in sqlite3 users db [ ] new modules - [ ] Google calculator module ( - Wind: 8 kts (9.2 mph) .. calc 8 kts in beaufort) - [ ] Google image search module - [ ] wwwtitle module - [ ] timezones module (?) - [ ] dictionary word lookup module (dictionary.com) - [ ] weather mdule - [ ] wiktionary module - [ ] wikipedia module + [ ] Google calculator ( - Wind: 8 kts (9.2 mph) .. calc 8 kts in beaufort) + [ ] Google image search + [ ] wwwtitle + [ ] timezones (?) + [ ] dictionary word lookup (dictionary.com) + [ ] weather + [ ] wiktionary + [ ] wikipedia + [ ] acronyms (http://acronyms.thefreedictionary.com/) +------------------------------------------------------------------------------ Milestone: 0.5 [ ] Python 3 support diff --git a/docs/modules b/docs/modules deleted file mode 100644 index 5603137..0000000 --- a/docs/modules +++ /dev/null @@ -1,4 +0,0 @@ -Modules - -The modules make use of __doc__ feature and class inheritance - you just need to write the functions and their documentation, but don't need to write anything for the bot to send the documentation when the help is requested. You can just read a few existing modules and make your own similarly. - -- GitLab