mirror of
https://github.com/Noratrieb/libuwuc.git
synced 2026-01-14 19:55:07 +01:00
docs
This commit is contained in:
parent
5d8814a9eb
commit
9bfadd77d9
5 changed files with 25 additions and 110 deletions
25
README.md
Normal file
25
README.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
# libuwuc
|
||||
|
||||
A libc implementation written in Rust.
|
||||
|
||||
## Layout
|
||||
|
||||
libuwuc consists of two crates, `libuwuc` and `rawc`. `libuwuc` is a normal Rust library
|
||||
and can be unit tested. It contains all the logic. `rawc` is a wrapper that declares all
|
||||
the symbols and is compiled to a staticlib/cdylib and then linked into your favourite C programs.
|
||||
|
||||
## How to build and test
|
||||
|
||||
You can build libuwuc using `cargo build`. Then, use `./uwuc-gcc` to build C programs.
|
||||
|
||||
`cargo test -p libuwuc` runs unit tests for the `libuwuc` crate. `./test_c.sh` runs
|
||||
the bespoke integration test suite with tests written in C.
|
||||
|
||||
## Why
|
||||
|
||||
yes!!!
|
||||
|
||||
## Platform Support
|
||||
|
||||
`libuwuc` supports anything that supports the Linux system call ABI but is only tested on actual Linux.
|
||||
Currently, it only supports x86-64, though that may change in the future.
|
||||
Loading…
Add table
Add a link
Reference in a new issue