Refactor the huge README.md into the more structured mkdocs.
I also cleaned up the installation section and added links to various competing redo implementations. The new README.md is basically just link to the docs on readthedocs.org, and a link to the mailing list. These docs need a *lot* more work, but this is enough of an improvement that I'll commit it anyway for now.
This commit is contained in:
parent
bde3b5526f
commit
d0607d0091
11 changed files with 1587 additions and 1477 deletions
36
Documentation/GettingStarted.md
Normal file
36
Documentation/GettingStarted.md
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
# Prerequisites
|
||||
|
||||
Currently, this version of redo requires python2.7 and the python2.7 sqlite3 module.
|
||||
Optional, but recommended, is the
|
||||
[setproctitle](http://code.google.com/p/py-setproctitle/) module, which makes your
|
||||
`ps` output prettier.
|
||||
|
||||
In modern versions of Debian, sqlite3 is already part of the python2.7 package.
|
||||
You can install the requirements like this:
|
||||
```sh
|
||||
sudo apt-get install python2.7 python-setproctitle
|
||||
```
|
||||
(If you have install instructions for other OSes, please add them here :))
|
||||
|
||||
|
||||
# Clone, compile, and test redo
|
||||
|
||||
You can run redo without installing it, like this:
|
||||
```sh
|
||||
git clone https://github.com/apenwarr/redo
|
||||
cd redo
|
||||
./redo -j10 test
|
||||
```
|
||||
|
||||
If the tests pass, you can either add $PWD/redo to your PATH, or install
|
||||
redo on your system. To install for all users, put it in /usr/local:
|
||||
|
||||
```sh
|
||||
PREFIX=/usr/local sudo ./redo install
|
||||
```
|
||||
|
||||
Or to install it just for yourself (without needing root access), put it in
|
||||
your home directory:
|
||||
```sh
|
||||
PREFIX=$HOME ./redo install
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue