From 9b0ed9199403703ba89f2ee04f5a8abfb642022a Mon Sep 17 00:00:00 2001
From: gry <guppy@123mail.org>
Date: Fri, 29 Apr 2011 11:57:19 +0930
Subject: [PATCH] Add documentation. Add .gitignore

---
 INSTALL      | 17 +++++++++++++++++
 README       | 21 +++++++++++++++++++++
 TODO         | 11 +++++++++++
 docs/modules |  4 ++++
 4 files changed, 53 insertions(+)
 create mode 100644 INSTALL
 create mode 100644 README
 create mode 100644 TODO
 create mode 100644 docs/modules

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..2fd0915
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,17 @@
+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
diff --git a/README b/README
new file mode 100644
index 0000000..ed2a176
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+guppy is a modular IRC bot. We would like to provide an easy to use alternative to other currently available IRC bots. 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 ~/.gpy/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
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..5fdd094
--- /dev/null
+++ b/TODO
@@ -0,0 +1,11 @@
+Milestone: 0.4
+[ ] admin' module in sqlite3 users db
+[ ] Python 3 support
+[ ] Google calculator module ( - Wind: 8 kts (9.2 mph) .. calc 8 kts in beaufort)
+[ ] Google image search module
+[ ] Get the title of a link module
+[ ] timezones module
+[ ] dictionary word lookup module
+[ ] weather module
+[ ] wiktionary/wikipedia lookup module
+
diff --git a/docs/modules b/docs/modules
new file mode 100644
index 0000000..5603137
--- /dev/null
+++ b/docs/modules
@@ -0,0 +1,4 @@
+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