reuler
Solutions to Project Euler in Rust
Description •
Install •
Usage •
Contribute
Description
`reuler` is a crate that contains the solutions for the [Project Euler](https://projecteuler.net/).
Note that this project is a Work In Progress.
Install
Install `reuler` by running :
```
cargo install reuler
```
Usage
You can simply run the command line followed by the ID of the problem your're trying to solve :
```console
reuler
```
---
For example, if you're trying to solve ["Amicable numbers"](https://projecteuler.net/problem=21) (problem #21), just run :
```console
reuler 21
```
Contribute
To contribute, install the package locally, create your own branch, add your code (and tests, and documentation), and open a PR !
### Code formatting
Ensure the code you added is properly formatted with :
```console
cargo fmt
```
### Tests
When you contribute, you need to make sure all the unit-tests pass. You should also add tests if necessary !
You can run the tests with :
```console
cargo test
```
### Documentation
The documentation should be kept up-to-date. You can visualize the documentation locally by running :
```console
cargo doc --open
```