~lbnz/xr0

784602029f7f06ead3d447620e4d59acb746042e — Claude Betz 2 months ago f4d8901 chore/readme
chore: update README
1 files changed, 33 insertions(+), 7 deletions(-)

M README.md
M README.md => README.md +33 -7
@@ 1,14 1,40 @@
# The Xr0 Semantic Abstractor for C
# Xr0 - C But Safe

Xr0 is a verifier for C that aims to guarantee the safety of C programs at
compile time. It will eliminate common pitfalls such as use-after-frees, double
frees, buffer out-of-bounds reads/writes, null pointer dereferences, uses of
uninitialised memory, arithmetic overflows/underflows and all other instances of
undefined behaviour in C.

View the project website [here](https://xr0.dev).

## Running Xr0
## Getting started

Check out the [tutorial](https://xr0.dev/learn) on the website.

## Contributing

The best way to contribute to Xr0 is to use it for something.

In that regard, we're forming a cohort for the first few users of Xr0.
Participation in the cohort will come with support and prioritisation (within
reason) of features in our roadmap as we work towards making Xr0 useful for
everyone.
And best of all, it'll be completely free.
The only thing is there's two of us, so we'll have to keep the cohort fairly
small.
Reach out via email to
[Claude](mailto:betz@xr0.dev) or
[Amisi](mailto:a@xr0.dev) or DM us on the
[Xr0 Zulip](https://xr0.zulipchat.com/login) if you're interested in this.

Clone the repo, then run
We are currently not accepting pull requests due to the early stage of Xr0.
However, if you have a serious proposal for how we can improve Xr0 you can
[make an issue](https://github.com/xr0-org/xr0/issues/new) to explain it.

```bash
make
./bin/0v -I libx tests/0-basic/030-alloc.x
```

## License

This project is distributed under the terms of the Apache 2.0 open source license.
Please refer to [LICENSE](https://github.com/xr0-org/xr0/blob/master/LICENSE)
for the full terms.