Document how to contribute and do development in the README

This commit is contained in:
Ribbon
2025-01-09 12:05:13 +00:00
parent faf62b7a78
commit e6f672bd48
+16
View File
@@ -10,3 +10,19 @@ Simply open `chan:<name>` with O_CREAT where `<name>` is any name you'd like to
This listener can accept clients by calling `dup("listen")`.
Open `chan:<name>` without O_CREAT to connect. Now you can read and write between both streams.
## 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.