Skip to content

Commit 51d6524

Browse files
committed
Merge branch 'master' of github.com:NicolasMemeint/matrix-rs
2 parents 30c8e0a + d174e5f commit 51d6524

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Matrix-rs: A generic matrix library in Rust
2+
3+
## Who, What & Why ?
4+
- I am a French student that is interested in programming (and in Rust since a couple months).
5+
- It is a matrix library written that has no intention to be *the best*.
6+
- To be better in Rust and discover some of its numerous aspects.
7+
8+
## Disclaimer
9+
This has no intention to be a somewhat *professional library*, so expect:
10+
- Bad commit messages & (non-existent?) changelog
11+
- Breaking-changes in the API
12+
- Not *top-of-the-line* optimization techniques
13+
- No guaranted regularity
14+
15+
If you are still interested, feel free to continue!
16+
17+
## Usage
18+
- Download the repository
19+
- `cargo build` it
20+
- *Voilà*
21+
22+
## Tests
23+
- `cargo test` in the root of the project
24+
25+
## Want to participate ?
26+
Create a new issue or a pull request and I will look at them (as soon as I can).

0 commit comments

Comments
 (0)