about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorlogin (thunix.net) <login@thunix.net>2020-12-22 05:25:06 -0500
committerlogin (thunix.net) <login@thunix.net>2020-12-22 05:25:06 -0500
commit78e039d24667dd73d94072ea62bea3f99527dca4 (patch)
tree5f5669e2db818927807b03f0c8ed11cf0ec8aed5
parent51a0f3167642b18da49300991bb5e9d7df2a10f4 (diff)
downloadtcoin-78e039d24667dd73d94072ea62bea3f99527dca4.tar.gz
Updated README.md with the correct instructions to use ntcoin
I had updated the 'ntcoin' script but had forgotten to change README.md.
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index b240777..f45be4a 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,11 @@ Currency simulator on tilde.town and other tildeboxes on tildeverse.org
 1. Clone the repo.
 2. Create a service user specifically for tcoin.
 3. Make sure you have `bash`, `realpath`, `echo`, `touch`, `mkdir`, `g++`, `head`, `true`, `base64`, and `cat` are available.
-4. Run `./ntcoin a b c` as the service user, where `a`, `b` and `c` are defined as follows:
+4. Run `./ntcoin a b c d` as the service user, where `a`, `b`, `c` and `d` are defined as follows:
     * `a`: the absolute path to the directory (without the trailing slash) where the `tcoin` folder containing all the users' data will be stored (i.e., the script will create the directory `a/tcoin/`)
     * `b`: the absolute path to the directory (without the trailing slash) where the `tcoin` and `pcoin` executables will be located, i.e., all users will have to have `r-x` permissions on `b` so that they can access the executables `b/tcoin` and `b/pcoin`. Please note that `b/tcoin` and `b/pcoin` will have the suid bit set. This means that when they run `b/tcoin` and `b/pcoin`, it will be with the uid of the service user (not their own uid). This is how they are able to send and receive coins only through the executables but not modify the `a/tcoin/` themselves.
     * `c`: an integer number of tildecoins that every user starts with. This is stored in `a/tcoin/base/base.txt`, and for universal-basic-income-style inflation, one can modify `a/tcoin/base/base.txt` using a cronjob. This will increase everybody's coins in real time.
-    
+    * `d`: a host name (in quotation marks, e.g., d = "tilde.town") that will appear in `tcoin --help`.
 ## Instructions to create program accounts
 1. Run `b/npcoin a` as the service user in the parent directory of the `tcoin` folder, i.e., if the `tcoin` folder is in directory with absolute path `x`, then run `cd x; b/npcoin a`. Here, `a` is the name of the program account you want to create, and `b` is the absolute path to the `tcoin` repository that contains the `npcoin` script. Program accounts should start with a capital letter (e.g., `My_program_account` or `My-program-account`).
 2. Add a line (ending with one newline character) to `tcoin/secrets/pcoin_keys` in the following format (assuming the name of the program is `My_program_account`):