From b26aa9b32be53e2d41f807d674c067969e3dd2d3 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Thu, 9 Jan 2025 11:54:44 +0000 Subject: [PATCH] Document how to contribute and do development in the README --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93a21c3cf1..0fa66e76dc 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ This section cover the interfaces used by Redox drivers. - `/scheme/memory/physical@wc`: write-combining memory - `/scheme/irq` - allows getting events from interrupts. It is used primarily by listening for its file descriptors using the `/scheme/event` scheme. -## Contributing +## Contribution Details ### Driver Design @@ -80,3 +80,19 @@ If you want to reverse enginner the existing drivers, you can access the BSD cod - [FreeBSD drivers](https://github.com/freebsd/freebsd-src/tree/main/sys/dev) - [NetBSD drivers](https://github.com/NetBSD/src/tree/trunk/sys/dev) - [OpenBSD drivers](https://github.com/openbsd/src/tree/master/sys/dev) + +## 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.