git.iko.soy/urbit.org
on master help sign in
Remove `bin/` from docs/using commands.

Most of our users are either likely simply getting their Urbit binary via `brew install`, or are following our docs/using/install step when building from source to install the binary to usr/local/bin. Thus, the `bin/` prefix to the Urbit admin commands in our current docs is kind of unneeded and worse might cause confusion if the command doens't work the first time. In this PR I added a note after our docs/using/install note when building from source to test that the `$ urbit` command works after installing to the user's path.

commitd3739ba1e2d64b469fba12ae37efc337b90b940f authorKeaton Dunsford <keaton@tlon.io> dateFri 10 Feb 2017, 08:54 (10 years ago) parent97ccf5f
3 files changed+14−6
compare with master
unifiedsplit
docs/using/admin.md+4−4 docs/using/install.md+8 docs/using/setup.md+2−2
docs/using/admin.md+4−4
@@ -10,7 +10,7 @@ title: Basic operation
1010<div class="row">
1111<div class="col-md-8">
1212
13−Your Urbit is a persistent Unix process that you mainly control from the console. For some things, a browser will also work.
13+Your Urbit is a persistent Unix process that you mainly control from the console. For some things, a browser will also work.
1414
1515</div>
1616</div>
@@ -23,18 +23,18 @@ You can turn your Urbit off with `ctrl-d` from the `:talk` or `:dojo` prompts.
2323
2424To restart your Urbit simply pass the name of your pier:
2525
26− $ bin/urbit some-planet
26+ $ urbit some-planet
2727
2828or
2929
30− $ bin/urbit comet
30+ $ urbit comet
3131
3232
3333## Logging
3434
3535To log Urbit's command line output to a file, use `script`:
3636
37− $ script urbit.log bin/urbit your-urbit
37+ $ script urbit.log urbit your-urbit
3838
3939## Console
4040
docs/using/install.md+8
@@ -101,6 +101,14 @@ After running `make`, your Urbit executable is in `bin/urbit`. Install it wherev
101101
102102 # sudo install -m 0755 bin/urbit /usr/local/bin
103103
104+Test that it works:
105+
106+ $ urbit
107+ simple usage:
108+ urbit -c <mycomet> to create a comet (anonymous urbit)
109+ urbit -w <myplanet> -t <myticket> if you have a ticket
110+ urbit <myplanet or mycomet> to restart an existing urbit
111+
104112## Setting up swap
105113
106114Urbit wants to map 2GB of memory when it boots up. We won’t
docs/using/setup.md+2−2
@@ -24,7 +24,7 @@ If you have an Urbit invitation, you'll have a planet like
2424`~fintud-macrep` and `~fortyv-tombyt-tabsen-sonres`. To create your
2525pier:
2626
27− $ bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
27+ $ urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
2828
2929This will create a directory `fintud-macrep/` and begin building your
3030urbit. This may take a few minutes.
@@ -33,7 +33,7 @@ If you do not have a ticket, you can still make a 'comet', a wild urbit
3333drifting through cyberspace. Pick your own directory name, it doesn't
3434matter:
3535
36− $ bin/urbit -c mycomet
36+ $ urbit -c mycomet
3737
3838This will create the directory `mycomet/` and generate a 128-bit
3939identity for your urbit.