Explorar o código

added default TOMLs to readme

lunar-mining %!s(int64=4) %!d(string=hai) anos
pai
achega
3c42509460
Modificáronse 1 ficheiros con 55 adicións e 9 borrados
  1. 55 9
      README.md

+ 55 - 9
README.md

@@ -1,20 +1,60 @@
 Not even an alpha product. Just a mere prototype(s).
 
-# First time running the demo:
+1. First time running the demo:
 
-1. Compile the project:
+Configure gatewayd, cashierd, darkfid and drk TOML files. Copy paste the following defaults to .config/darkfi:
 
-```console
-$ cargo build --release
+**gatewayd.toml**
+
+```
+connect_url = "127.0.0.1:3333"
+publisher_url = "127.0.0.1:4444"
+database_path = "gatewayd.db"
+log_path = "/tmp/gatewayd.log"
+```
+
+**cashierd.toml**
+
+```
+accept_url = "127.0.0.1:7777"
+rpc_url = "http://127.0.0.1:8000"
+client_database_path = "cashier_client_database.db"
+btc_endpoint = "tcp://electrum.blockstream.info:50001"
+gateway_url = "127.0.0.1:3333"
+log_path = "/tmp/cashierd.log"
+cashierdb_path = "/home/x/.config/darkfi/cashier.db"
+client_walletdb_path = "/home/x/.config/darkfi/cashier_client_walletdb.db"
+password = ""
+client_password = ""
 ```
 
-2. Set a wallet password. Note: you must set a password before using the wallet.
+**darkfid.toml**
 
-Open .config/darkfi/darkfid.toml and add a password to the 'Password' section.
+```
+connect_url = "127.0.0.1:3333"
+subscriber_url = "127.0.0.1:4444"
+cashier_url = "127.0.0.1:7777"
+rpc_url = "127.0.0.1:8000"
+database_path = "/home/x/.config/darkfi/database_client.db"
+walletdb_path = "/home/x/.config/darkfi/walletdb.db"
+log_path = "/tmp/darkfid_service_daemon.log"
+password = ""
+```
 
-3. Set a cashier password and a cashier client password.
+**drk.toml**
 
-Open .config/darkfi/cashierd.toml. Add a password to the 'Password' section, and a another password to the 'Client Password' section.
+```
+rpc_url = "http://127.0.0.1:8000"
+log_path = "/tmp/drk_cli.log"
+```
+
+2. Configure the password field on all TOML files.
+
+3. Compile the project:
+
+```console
+$ cargo build --release
+```
 
 4. Run the gateway daemon:
 
@@ -34,12 +74,18 @@ $ cargo run --bin cashierd -- -v
 $ cargo run --bin darkfid -- -v
 ```
 
-7. Initialize wallet and generate key pair:
+7. Initialize drk wallet and generate a key pair:
 
 ```console
 $ cargo run --bin drk -- -wk 
 ```
 
+8. Play.
+
+```console
+$ cargo run --bin drk -- -help
+```
+
 # Every time running the demo:
 
 Run gateway daemon: