From 632459e5be6c62050a4c977c633faf16fcfc5dc1 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Thu, 15 May 2025 23:29:52 -0300 Subject: [PATCH] Add a README and simplify the daemon READMEs --- README.md | 33 +++++++++++++++++++++++++++++++++ bootstrap/README.md | 16 ---------------- init/README.md | 16 ---------------- ipcd/README.md | 16 ---------------- logd/README.md | 16 ---------------- ramfs/README.md | 16 ---------------- randd/README.md | 16 ---------------- zerod/README.md | 16 ---------------- 8 files changed, 33 insertions(+), 112 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..7e5a0acf6b --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Base + +Repository containing various system daemons, that are considered fundamental for the OS. + +You can see what each component does in the following list: + +- audiod - Daemon used to process the sound drivers audio +- bootstrap - First code that the kernel executes, responsible for spawning the init daemon +- init - Daemon used to start most system components and programs +- initfs - TODO +- ipcd - Daemon used for inter-process communication +- logd - Daemon used to log system components and daemons +- netstack - Daemon used for networking +- ptyd - Daemon used for pseudo-terminal +- ramfs - RAM filesystem +- randd - Daemon used for random number generation +- zerod - Daemon used to discard all writes and fill read buffers with zero + +## 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. diff --git a/bootstrap/README.md b/bootstrap/README.md index a56ea88e81..dd4493e72e 100644 --- a/bootstrap/README.md +++ b/bootstrap/README.md @@ -2,22 +2,6 @@ First code that the kernel executes, responsible for spawning init. -## 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. - ## Funding - Process Manager (`src/procmgr.rs`) The _Unix-style Signals and Process Management_ project is funded through [NGI Zero Core](https://nlnet.nl/core), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/RedoxOS-Signals). diff --git a/init/README.md b/init/README.md index bfa86d6df4..fb145afaad 100644 --- a/init/README.md +++ b/init/README.md @@ -12,19 +12,3 @@ Init is currently being rewritten to support a couple of behaviors that are help - Service management - Enable and disable services - Restart failed services - -## 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. diff --git a/ipcd/README.md b/ipcd/README.md index 8f726664b9..553034bdf4 100644 --- a/ipcd/README.md +++ b/ipcd/README.md @@ -10,19 +10,3 @@ Simply open `chan:` with O_CREAT where `` is any name you'd like to This listener can accept clients by calling `dup("listen")`. Open `chan:` 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. diff --git a/logd/README.md b/logd/README.md index be1f2d5f1b..0a49565cdc 100644 --- a/logd/README.md +++ b/logd/README.md @@ -1,19 +1,3 @@ # logd Log daemon for collecting all log output. - -## 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. diff --git a/ramfs/README.md b/ramfs/README.md index 16f2102005..d1c0773204 100644 --- a/ramfs/README.md +++ b/ramfs/README.md @@ -1,18 +1,2 @@ # ramfs A mountable filesystem, which contents is stored in RAM. Useful for early logging, before `redoxfs` has been started. The `initfs:` scheme seems to lack read-write support, and thus this ramfs driver allows logs to be written in initfs drivers. - -## 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. diff --git a/randd/README.md b/randd/README.md index 96c6b227ff..ebe0f604eb 100644 --- a/randd/README.md +++ b/randd/README.md @@ -1,19 +1,3 @@ # randd Random number generator daemon. - -## 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. diff --git a/zerod/README.md b/zerod/README.md index 0b1511011d..602bf383f7 100644 --- a/zerod/README.md +++ b/zerod/README.md @@ -1,19 +1,3 @@ # zerod A daemon that will discard all writes and always fill read buffers with zero. - -## 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.