README for Rubric

Rubric is a note-keeping system that also serves as a bookmark manager.  Users
store entries, which are small (or large) notes with a set of categorizing
"tags."  Entries may also refer to URIs.

--- WARNING ---

This is young software, likely to have bugs and likely to change in strange
ways.  I will try to keep the documented API stable, but not if it makes
writing Rubric too inconvenient.

Basically, just take note that this software is still version 0.0x; it works,
but it's still very much under construction.

--- UPGRADING ---

Things you'll have to do:

1. install the new templates (and probably the css)
2. install the modules
3. run updatedb.pl (from the location of rubric.cgi/.yml)
4. update your config
   (recently new: smtp_server and email_from)

--- INSTALLATION ---

Things you'll have to do to use it:

1. install the modules with the usual "make install"
2. put rubric.cgi and rubric.yml somewhere together in your docroot
3. put the templates somewhere
4. update rubric.yml
5. run the included makedb to generate rubric.db
6. put rubric.db somewhere
7. set rubric.db a+w; you may need its location to be 0777; not sure yet
8. create a user object for yourself
   you could just run the filldb script to get some bogus data, but... why?
9. get your bookmarks from delicious with my delicious-backup
   delbackup -y | load_yml USERNAME
A. (optional) set up .htaccess to prevent access to rubric.db and .yml
B. go?

--- OTHER INFORMATION ---

simple bookmarklet:
	javascript:location.href='http://server.name.tld/rubric/post?uri='+escape(location.href)+'&title='+escape(document.title)+'&when_done=go_Back'
