update README and add Github mirroring to autobuild

This commit is contained in:
swaits committed 2024-08-15 10:04:10 -06:00
1 parent 498f1fa872
commit f3b9dba943
2 files changed
+25 -8

No files matched your search

+11
View File
@@ -0,0 +1,11 @@
image: alpine/edge
secrets:
- 88cce185-d2ec-4573-9546-e33f36f79bbf
sources:
- git+ssh://git@git.sr.ht/~swaits/mcps
tasks:
- mirror-to-github: |
cd ~/mcps
ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts
git remote add github git@github.com:swaits/mcps.git
git push --mirror github
+14 -8
View File
@@ -21,16 +21,22 @@ schedule durations and total work effort.
### Prerequisites
- **Rust**: You'll need to have Rust installed on your system to build the
project. You can install Rust using `rustup`:
You'll need to have Rust installed on your system to build the project. You can
install Rust using `rustup`:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Building from Source
- Clone and build the repository:
_Preferred_: Install directly from crates.io:
```bash
cargo install mcps
```
_Alternative_: Clone and build the repository locally:
```bash
git clone <git@git.sr.ht>:~swaits/mcps
@@ -48,10 +54,10 @@ file in YAML or JSON format.
### Basic Usage
```bash
./mcps example.yaml -i 100000 -w 10
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` schedule file
with 100,000 iterations and overrides the number of workers to 10.
### Command-Line Options