# soly
[](https://crates.io/crates/soly)
[](https://docs.rs/soly)
[](https://github.com/CarteraMesh/soly/actions)
[](https://codecov.io/github/CarteraMesh/soly)
## Installation
### Cargo
* Install the rust toolchain in order to have cargo installed by following
[this](https://www.rust-lang.org/tools/install) guide.
* run `cargo install soly`
## Development
### Prerequisites
- **Rust Nightly**: Required for code formatting with advanced features
```bash
rustup install nightly
```
### Getting Started
1. **Clone the repository**
```bash
git clone https://github.com/CarteraMesh/soly.git
cd soly
```
2. **Build and test**
```bash
cargo build
cargo test
cargo +nightly fmt --all
```
### Code Formatting
This project uses advanced Rust formatting features that require nightly:
```bash
# Format all code
cargo +nightly fmt --all
# Check formatting
cargo +nightly fmt --all -- --check
```
## License
* MIT license
[LICENSE-MIT](LICENSE-MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
See [CONTRIBUTING.md](CONTRIBUTING.md).