[Checkins] SVN: Sandbox/luciano/kirbi/src/kirbi/README.txt replaced default README.txt with one about Kirbi

Luciano Ramalho luciano at ramalho.org
Wed Jul 11 15:13:14 EDT 2007


Log message for revision 77695:
  replaced default README.txt with one about Kirbi
  

Changed:
  U   Sandbox/luciano/kirbi/src/kirbi/README.txt

-=-
Modified: Sandbox/luciano/kirbi/src/kirbi/README.txt
===================================================================
--- Sandbox/luciano/kirbi/src/kirbi/README.txt	2007-07-11 16:23:50 UTC (rev 77694)
+++ Sandbox/luciano/kirbi/src/kirbi/README.txt	2007-07-11 19:13:14 UTC (rev 77695)
@@ -1,8 +1,55 @@
-Put your application code in this Python package.
+=============================
+Kirbi: a P2P library manager
+=============================
 
-app_templates
-  Place Page Templates (file extension '.pt') in this directory.  They
-  will automatically be associated as views with the model in app.py.
+Kirbi is a sample application to test Grok and help programmers learn
+how to use it to build a complete app.
 
-static
-  Place static resources such as CSS, JS, images, etc. in here.
+Kirbi also aims to be useful and not just a sample. It is a system to allow
+friends and colleagues to share their books and DVDs without losing track
+of them.
+
+Use cases
+===========
+
+Done
+-----
+
+* Add books to the public catalog via a Web form or XML-RPC
+
+* Allow searches to the public catalog
+
+To Do
+------
+
+* Add books by entering just the ISBN, and letting Kirbi fetch the book data
+  from Amazon.com (under development)
+
+* Add books by entering title words or author names, and letting Kirbi fetch
+  some likely candidates from Amazon.com
+  
+* User self-registration
+
+* User catalogs own collections
+
+* User invites friends to share specific collections
+
+* User requests to borrow an item
+
+* User approves the loan of an item
+
+* User tracks lent items
+
+* User tracks borrowed items
+
+
+Other tasks
+===========
+
+* Add tests
+
+* Packaging (buildout, eggification)
+
+* AJAXification using some framework (whatever Uli chooses for the Grok Admin
+  UI, currently MojiKit or KSS)
+



More information about the Checkins mailing list