Added OSX section to README.md (#1888)

Merge pull request #1888 Added OSX section to README.md * pull/1888/head: Added OSX section to README.md
tari-project · May 20, 2020 · e262005 · e262005
2 parents 023cc86 + ca6801b
commit e262005
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -15,15 +15,24 @@ You can check that the binaries match the hash by running
 
     sha256sum path/to/tari_base_node
 
-### Building from source (Ubuntu 18.04)
+## Building from source
 
-To build the Tari codebase from source, there are a few dependencies you need to have installed.
+### Building from source (*nix)
 
+To build the Tari codebase from source, there are a few dependencies you need to have installed.
 
-#### Install development packages
+#### Install development packages 
 
 First you'll need to make sure you have a full development environment set up:
 
+#### (macOS)
+
+```
+brew install cmake
+```
+
+#### (Ubuntu 18.04)
+
 ```
 sudo apt-get -y install openssl libssl-dev pkg-config libsqlite3-dev clang git cmake libc++-dev libc++abi-dev libprotobuf-dev protobuf-compiler
 ```
@@ -71,6 +80,8 @@ on your system.
 
     cargo install --path=applications/tari_base_node --force
 
+---
+
 ### Building from source (Windows 10)
 
 To build the Tari codebase from source on Windows 10, there are a few dependencies you need to have installed.
@@ -200,6 +211,8 @@ Using all the default options, the blockchain database, wallet database, log fil
 created in the `~/.tari` (on Linux) or `%USERPROFILE%\.tari` (on Windows) folder. Alternatively, by specifying 
 `--base-path <base-path>` on the command line as well, all of this will be created in that folder.  
 
+---
+
 ### Building a docker image
 
 If you don't want to use the docker images provided by the community, you can roll your own!
@@ -218,6 +231,8 @@ Test your image
 
     docker run tari_base_node tari_base_node --help
 
+---
+
 ### Advanced build configurations
 
 * [Building with Vagrant](https://github.com/tari-project/tari/issues/1407)

diff --git a/applications/tari_base_node/osx/install.sh b/applications/tari_base_node/osx/install.sh
@@ -83,7 +83,7 @@ fi
 
 # Configure Base Node
 ./tari_base_node --init
-./tari_base_node --create_id
+./tari_base_node --create-id
 
 banner Running Tari Base Node
 # Run Base Node

diff --git a/applications/tari_base_node/setup.sh b/applications/tari_base_node/setup.sh
@@ -29,7 +29,7 @@ osascript -e "tell application \"Terminal\" to do script \"sh ${PWD}/start_tor.s
 # Configure Base Node
 cd "${INSTALL_ROOT}" || exit
 tari_base-node --init
-tari_base_node --create_id
+tari_base_node --create-id
 
 # Run Base Node
 tari_base_node
diff --git a/applications/tari_base_node/src/main.rs b/applications/tari_base_node/src/main.rs
@@ -46,7 +46,7 @@
 /// ```
 ///
 /// For the first run
-/// ```cargo run tari_base_node -- --create_id```
+/// ```cargo run tari_base_node -- --create-id```
 /// 
 /// Subsequent runs
 /// ```cargo run tari_base_node```
@@ -312,7 +312,7 @@ fn cli_loop(parser: Parser, mut shutdown: Shutdown) {
     }
 }
 
-/// Loads the node identity, or creates a new one if the --create_id flag was specified
+/// Loads the node identity, or creates a new one if the --create-id flag was specified
 /// ## Parameters
 /// `identity_file` - Reference to file path
 /// `public_address` - Network address of the base node
@@ -335,7 +335,7 @@ fn setup_node_identity(
                 error!(
                     target: LOG_TARGET,
                     "Node identity information not found. {}. You can update the configuration file to point to a \
-                     valid node identity file, or re-run the node with the --create_id flag to create a new identity.",
+                     valid node identity file, or re-run the node with the --create-id flag to create a new identity.",
                     e
                 );
                 return Err(ExitCodes::ConfigError);

diff --git a/common/src/configuration/bootstrap.rs b/common/src/configuration/bootstrap.rs
@@ -278,7 +278,7 @@ mod test {
         let dir = &PathBuf::from(temp_dir.path().to_path_buf().display().to_string().to_owned() + "/01/02/");
         let data_path = default_subdir("", Some(dir));
         let mut bootstrap =
-            ConfigBootstrap::from_iter_safe(vec!["", "--base_dir", &data_path.as_str(), "--init", "--create_id"])
+            ConfigBootstrap::from_iter_safe(vec!["", "--base_dir", &data_path.as_str(), "--init", "--create-id"])
                 .expect("failed to process arguments");
 
         // Initialize bootstrap dirs