ztr/CPC
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Kasper 2021-02-01 00:53:55 +01:00 committed by GitHub
parent 6b7f0687ac
commit e4684e72e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -20,7 +20,7 @@ To install the CLI using `cargo`:
cargo install cpc cargo install cpc
``` ```
To install the CLI directly, grab the appropriate binary from [cpc's Releases page on GitHub](https://github.com/probablykasper/cpc/releases), then place it wherever you normally place binaries on your OS (On Windows, you may need to edit your PATH variable or something). To install the CLI directly, grab the appropriate binary from [cpc's Releases page on GitHub](https://github.com/probablykasper/cpc/releases), then place it wherever you normally place binaries on your OS.
## CLI Usage ## CLI Usage
@ -110,7 +110,7 @@ cpc returns `Result`s with basic strings as errors. Just to be safe, you may wan
## Dev Instructions ## Dev Instructions
### Get started ### Get started
Install [Rust](https://www.rust-lang.org). This project was built in Rust 1.45. Install [Rust](https://www.rust-lang.org).
Run cpc with a CLI argument as input: Run cpc with a CLI argument as input:
``` ```
@ -213,7 +213,7 @@ The compiled binaries will now be available inside `target/<target>/release/`. T
### Releasing a new version ### Releasing a new version
1. Update `CHANGELOG.md` 1. Update `CHANGELOG.md`
2. Bump the version number in `Cargo.toml` and run `cargo check` 2. Bump the version number in `Cargo.toml`
3. Run `cargo test` 3. Run `cargo test`
4. Cross-compile cpc by following [the steps above](#cross-compiling) 4. Cross-compile cpc by following [the steps above](#cross-compiling)
5. Commit and tag in format `v#.#.#` 5. Commit and tag in format `v#.#.#`