Document how to contribute and do development in the README

This commit is contained in:
Ribbon
2025-01-09 11:54:44 +00:00
parent e4ac216fe2
commit b26aa9b32b
+17 -1
View File
@@ -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.