Skip to content

Commit

Permalink
Link to contribution standards from the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Notgnoshi committed May 11, 2024
1 parent 25dd66a commit 2566103
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,15 @@
**Herostratus** *n.* **1.** An ancient Greek known for winning fame through crime and destruction.
**2.** A Git repository achievements engine.

## How to run
**NOTE:** This will change a lot:
```sh
$ cargo run -- $PWD origin/test/fixup
Achievement { name: "I meant to fix that up later, I swear!", commit: 2721748d8fa0b0cc3302b41733d37e30161eabfd }
Achievement { name: "I meant to fix that up later, I swear!", commit: a987013884fc7dafbe9eb080d7cbc8625408a85f }
Achievement { name: "I meant to fix that up later, I swear!", commit: 60b480b554dbd5266eec0f2378f72df5170a6702 }
```
## Usage
**TODO:** This will change a lot

## How to test
Run the usual `cargo test`.
## Development

## Test Branches
### Build and test
The usual `cargo build` and `cargo test`.

### Test Branches
There are orphan test branches in this repository used for integration tests.

For example, the `test/simple` branch was created like this:
Expand All @@ -28,3 +24,6 @@ for i in `seq 0 4`; do
git commit --allow-empty -m "test/simple: $i"
done
```

### Contribution
Contribution is welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution standards.

0 comments on commit 2566103

Please sign in to comment.