diff --git a/README.md b/README.md index da2cd157a594d86263ebda30361ed29b8380c2fe..a48d27fe7a8ecc2202122374885f32294e49ed47 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,7 @@ # relibc  relibc is a portable POSIX C standard library written in Rust. It is under heavy development, and currently supports Redox and Linux. + +The motivation for this project is twofold: Reduce issues the redox crew was having with newlib, and create a safer alternative to a C standard library written in C. It is mainly designed to be used under redox, as an alternative to newlib, but it also supports linux syscalls via the [sc](https://crates.io/crates/sc) crate. + +## Contributing +Just search for any invocation of the `unimplemented` macro, and hop in! The ci server checks builds for linux and redox, checks formatting (via rustfmt), and runs the test suite. Run `ci.sh` locally to check that your changes will pass travis. Use `fmt.sh` to format your code and `test.sh` to run the C test suite.