From 9c7c874cbcfbca23e33cdb2309bdc8a0a45f64a0 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Thu, 9 Jan 2025 11:58:27 +0000 Subject: [PATCH] Document how to contribute and do developpment in the README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index b5c71c0b76..633dd04a1e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # Redox OS userspace networking stack This repository contains the networking stack for Redox OS. It makes use of [smoltcp](https://github.com/m-labs/smoltcp). + +## How To Contribute + +To learn how to contribute to this system component you need to read the following document: + +- [CONTRIBUTING.md](https://gitlab.redox-os.org/redox-os/redox/-/blob/master/CONTRIBUTING.md) + +## Development + +To learn how to do development with this system component inside the Redox build system you need to read the [Build System](https://doc.redox-os.org/book/build-system-reference.html) and [Coding and Building](https://doc.redox-os.org/book/coding-and-building.html) pages. + +### How To Build + +To build this system component you need to download the Redox build system, you can learn how to do it on the [Building Redox](https://doc.redox-os.org/book/podman-build.html) page. + +This is necessary because they only work with cross-compilation to a Redox virtual machine, but you can do some testing from Linux.