Commits

WAKAYAMA shirou committed d470b74

move from README to README.rst with explicit extension. and add some document.

  • Participants
  • Parent commits b42daad

Comments (0)

Files changed (2)

README

-memocurial
-==========
-mercurial base paste tool.
+memocurial
+==========
+
+Mercurial based paste tool.
+
+Memocurial uses `Mercurial<http://mercurial.selenic.com/>`_ to store
+every pasted text. You don't have to prepare any DBs.
+
+Requirement
+---------------
+
+- python
+- mercurial
+
+How to use
+---------------
+
+0. clone
+
+   $ hg clone https://bitbucket.org/troter/memocurial
+   $ cd memocurial
+
+1. create bootstrap
+
+   $ python bootstrap.py -d
+
+2. edit host or port
+
+   $ vi buildout.cfg
+
+3. run buildout
+
+   $ bin/buildout
+
+4. create initial database
+
+   $ bin/memocurial init-db -c parts/etc/production.ini
+
+5. run server
+
+   $ bin/memocurial runserver -c parts/etc/production.ini
+
+buildout.cfg
+++++++++++++++++++
+
+host
+    hostadress. if set 0.0.0.0, the server will listen in all address.
+port
+    port no.
+
+
+License
+--------------
+
+
+Repository
+-----------------
+
+- https://bitbucket.org/troter/memocurial