From e7d6bbf4c9eff7d3f4c6921efce7668c6d9f5881 Mon Sep 17 00:00:00 2001 From: Stephen Waits Date: Thu, 15 Aug 2024 10:22:41 -0600 Subject: [PATCH] doc: updates to README.md --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ccc1a42..f3fdb5d 100644 --- a/README.md +++ b/README.md @@ -28,18 +28,16 @@ install Rust using `rustup`: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` -### Building from Source - -_Preferred_: Install directly from crates.io: +### Option 1: Install from Crates.io (preferred) ```bash cargo install mcps ``` -_Alternative_: Clone and build the repository locally: +### Option 2: Clone and build the repository locally ```bash -git clone :~swaits/mcps +git clone https://github.com/swaits/mcps.git cd mcps cargo build --release ``` @@ -57,7 +55,7 @@ file in YAML or JSON format. mcps example.yaml -i 100000 -w 10 ``` -This command runs the Monte Carlo simulation on the `example.yaml` schedule file +This command runs the Monte Carlo simulation on the [`example.yaml`](./example.yaml) schedule file with 100,000 iterations and overrides the number of workers to 10. ### Command-Line Options @@ -85,6 +83,9 @@ tasks: dependencies: [DesignPhase] ``` +This repo includes examples in [JSON](./example.json) and +[YAML](./example.yaml). + ### Example Output The tool generates an ASCII-based cumulative distribution function (CDF) graph, @@ -110,4 +111,4 @@ always welcome! ### License -This project is licensed under the MIT License. See the LICENSE file for details. +This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.