Skip to content

Commit

Permalink
docs: separate CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
moreal committed Jul 4, 2024
1 parent efc80b5 commit c05f371
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 18 deletions.
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Build

You can build and test the code with [cargo] command.

If you want to build for only bytes <-> Bencodex:

```
cargo build
```

If you want to build JSON feature too:

```
cargo build --features JSON
```

If you want to build JSON CLI tool too:

```
cargo build --features json-cli
```

# Test

If you want to test:

```
cargo test --features test
```

If you want to test JSON-related tests too:

```
cargo test --features test,json
```

# Format

```
cargo fmt
cargo clippy
```

[cargo]: https://github.com/rust-lang/cargo/
18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,21 +94,3 @@ $ echo -n '"123"' | bencodex -d
$ echo -n 'null' | bencodex -d
n
```

## Building and Testing

You can build and test the code with [cargo] command.

If you want to build:

```
cargo build
```

If you want to test:

```
cargo test --features test
```

[cargo]: https://github.com/rust-lang/cargo/

0 comments on commit c05f371

Please sign in to comment.