diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ddeac8444c873385e6dfe8ba565c674ebe569a77..f4a48fb3a7fff28bee2a3b330f319cd89f43bb5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,12 +11,22 @@ Maintaining a libc is tough work, and we'd love some help! ## What to do +To get started, you'll need to execute: + +```git-clone --recurse-submodules ``` + +If cargo ever complains about not having a file, +you might need to do: `git submodule init` and/or `git submodule update` + For now, we are still trying to get full libc compatibility before we move on to any optimisation. - We currently have a number of unimplemented functions. Search for `unimplemented!()` and hop right in! - If you notice any missing functionality, feel free to add it in +- Good places to look at the current implementations are: + [here](https://gitlab.com/bminor/musl/) and [here](https://code.woboq.org/userspace/glibc/). +- To compile, just execute `cargo build`. ## Code style diff --git a/ci.sh b/ci.sh index 5432f31b58a347eb6213351aa3c1ff2c087c0c7d..3f29adc31735e3f3d97227ab0af663260b236140 100755 --- a/ci.sh +++ b/ci.sh @@ -1,7 +1,7 @@ #!/bin/bash set -ex -./fmt.sh -- --write-mode=diff +./fmt.sh -- --check if [ -z "$TARGET" ] then make all