From 0dcc685739d4599b0ae1e51aa76b1137e829d377 Mon Sep 17 00:00:00 2001 From: Avery Pennarun Date: Sun, 3 Mar 2019 19:30:37 -0500 Subject: [PATCH] Minor clarifications to redo install instructions. Reported-by: @DRMacIver on twitter --- README.md | 17 +++++++++++++---- docs/GettingStarted.md | 4 ++-- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5812b3d..c2b1210 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,23 @@ 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`. +To build and test redo, run: +```sh + ./do -j10 test +``` + +To install it, run something like this: +```sh + DESTDIR= 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)). + 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). + `redo-list+subscribe@googlegroups.com` (note the plus sign). You can + send questions or feedback (with or without subscribing) by sending + messages to `redo-list@googlegroups.com`. diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index c860199..b42f415 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -26,13 +26,13 @@ If the tests pass, you can either add $PWD/redo/bin 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 + DESTDIR= PREFIX=/usr/local sudo ./do install ``` Or to install it just for yourself (without needing root access), put it in your home directory: ```sh - PREFIX=$HOME ./redo install + DESTDIR= PREFIX=$HOME ./do install ```