diff options
| author | Tom Ryder <tom@sanctum.geek.nz> | 2017-04-07 12:27:30 +1200 |
|---|---|---|
| committer | Tom Ryder <tom@sanctum.geek.nz> | 2017-04-07 12:27:30 +1200 |
| commit | 8561f37448e00c795602f0e87dd71fc67a1d2676 (patch) | |
| tree | c35dbbb0076aedf45e2fca0e264d2f5d000fa5fa /README.markdown | |
| parent | Combine unnecessary split line (diff) | |
| download | dotfiles-8561f37448e00c795602f0e87dd71fc67a1d2676.tar.gz dotfiles-8561f37448e00c795602f0e87dd71fc67a1d2676.zip | |
Add some more comments to README
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/README.markdown b/README.markdown index 99e486d1..8a85f048 100644 --- a/README.markdown +++ b/README.markdown @@ -16,8 +16,12 @@ Installation $ make install For the default `all` target, you'll need `make(1)`, `m4(1)`, and a -POSIX-fearing `sh(1)`. If you're on a system where `/bin/sh` is not a POSIX -shell, you may need to check you have e.g. `/usr/xpg4/bin` at the front of your +POSIX-fearing environment, including `sh(1)`. This should work on most +GNU/Linux and BSD systems, and possibly on other UNIX types, but those are not +as thoroughly or frequently tested. + +If you're on a system where `/bin/sh` is not a POSIX shell (e.g. OpenSolaris), +you may need to check you have e.g. `/usr/xpg4/bin` at the front of your `$PATH` at build time. The installation `Makefile` will overwrite things standing in the way of its @@ -31,7 +35,8 @@ directory so you can explore: $ env -i HOME="$tmpdir" TERM="$TERM" bash -l The default `install` target will install these targets and all their -dependencies: +dependencies. Note that you don't actually have to have any of this except `sh` +installed. * `install-bash` * `install-bin` @@ -149,8 +154,8 @@ A terminal session with my prompt looks something like this: tom@remote:~/.dotfiles(master+!){1}$ The username and hostname are elided if not connected via SSH. The working -directory is always shown. The rest of the prompt expands based on context to -include these elements in this order: +directory with tilde abbreviation for `$HOME` is always shown. The rest of the +prompt expands based on context to include these elements in this order: * Whether in a Git repository if applicable, and punctuation to show repository status including reference to upstreams at a glance. Subversion |