apenwarr-redo/README.md

# redo - a recursive build system

Smaller, easier, more powerful, and more reliable than `make`.

This is an implementation of [Daniel J. Bernstein's redo
build system](http://cr.yp.to/redo.html).  He never released his
version, so other people have implemented different variants based on his
published specification.

This version, sometimes called apenwarr/redo, is probably the most advanced
one, including parallel builds, improved logging, extensive automated tests,
and helpful debugging features.

To build and test redo, run `./do -j10 test`.  To install it, run
`DESTDIR=/tmp/testinstall PREFIX=/usr/local ./do -j10 install`.

---

- View the [documentation](https://redo.rtfd.io) via readthedocs.org
- Visit the [source code](https://github.com/apenwarr/redo) on github
- Discussions and support via the
    mailing list ([archives](https://groups.google.com/group/redo-list)).
    You can subscribe by sending any email message to
    `redo-list+subscribe@googlegroups.com` (note the plus sign).
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. 2018-11-16 03:13:33 -05:00			`# redo - a recursive build system`
Add README.md and LICENSE. LGPLv2, by the way. 2010-11-17 00:40:06 -08:00
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. 2018-11-16 03:13:33 -05:00			Smaller, easier, more powerful, and more reliable than `make`.
Add README.md and LICENSE. LGPLv2, by the way. 2010-11-17 00:40:06 -08:00
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. 2018-11-16 03:13:33 -05:00			`This is an implementation of [Daniel J. Bernstein's redo`
			`build system](http://cr.yp.to/redo.html). He never released his`
			`version, so other people have implemented different variants based on his`
			`published specification.`
Add README.md and LICENSE. LGPLv2, by the way. 2010-11-17 00:40:06 -08:00
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. 2018-11-16 03:13:33 -05:00			`This version, sometimes called apenwarr/redo, is probably the most advanced`
Move _all.do -> all.do and slightly update docs. all.do's main job was to print a "nothing much to do" message after running. Nowadays it actually does do stuff, so we can remove the warning, making _all.do redundant. 2018-12-31 15:07:18 -05:00			`one, including parallel builds, improved logging, extensive automated tests,`
			`and helpful debugging features.`
Add README.md and LICENSE. LGPLv2, by the way. 2010-11-17 00:40:06 -08:00
Directory reorg: move code into redo/, generate binaries in bin/. It's time to start preparing for a version of redo that doesn't work unless we build it first (because it will rely on C modules, and eventually be rewritten in C altogether). To get rolling, remove the old-style symlinks to the main programs, and rename those programs from redo-.py to redo/cmd_.py. We'll also move all library functions into the redo/ dir, which is a more python-style naming convention. Previously, install.do was generating wrappers for installing in /usr/bin, which extend sys.path and then import+run the right file. This made "installed" redo work quite differently from running redo inside its source tree. Instead, let's always generate the wrappers in bin/, and not make anything executable except those wrappers. Since we're generating wrappers anyway, let's actually auto-detect the right version of python for the running system; distros can't seem to agree on what to call their python2 binaries (sigh). We'll fill in the right #! shebang lines. Since we're doing that, we can stop using /usr/bin/env, which will a) make things slightly faster, and b) let us use "python -S", which tells python not to load a bunch of extra crap we're not using, thus improving startup times. Annoyingly, we now have to build redo using minimal/do, then run the tests using bin/redo. To make this less annoying, we add a toplevel ./do script that knows the right steps, and a Makefile (whee!) for people who are used to typing 'make' and 'make test' and 'make clean'. 2018-12-03 21:39:15 -05:00			To build and test redo, run `./do -j10 test`. To install it, run
			`DESTDIR=/tmp/testinstall PREFIX=/usr/local ./do -j10 install`.

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. 2018-11-16 03:13:33 -05:00			`---`
Add README.md and LICENSE. LGPLv2, by the way. 2010-11-17 00:40:06 -08:00
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. 2018-11-16 03:13:33 -05:00			`- View the [documentation](https://redo.rtfd.io) via readthedocs.org`
			`- Visit the [source code](https://github.com/apenwarr/redo) on github`
			`- Discussions and support via the`
Move _all.do -> all.do and slightly update docs. all.do's main job was to print a "nothing much to do" message after running. Nowadays it actually does do stuff, so we can remove the warning, making _all.do redundant. 2018-12-31 15:07:18 -05:00			`mailing list ([archives](https://groups.google.com/group/redo-list)).`
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. 2018-11-16 03:13:33 -05:00			`You can subscribe by sending any email message to`
			`redo-list+subscribe@googlegroups.com` (note the plus sign).