Contributing
Welcome to the contribution guide! In here you will learn;
- The internal structure of the source tree,
- How other projects inside the source tree work,
- And how to build an rootfs to test your changes!
We recommend you check out The manpages for more detailed and up-to-date information.
Pages
- Code stylingThis page describes the coding style that is preferred on Kreato Linux projects. If you are looking to contribute, please consider the points here. This page was heavily inspired by Linux kernel coding standards, in terms of how it is laid out. Indentation Most of Kreato Linux code is written in Nim, so indentation is very important. Indents should be 2 characters most of the time. 4 characters are also accepted, but not more.
- How to build a rootfsUse krep rootfs to build a Kreato Linux root filesystem. krep replaces the standalone Kreastrap tool. Profiles are declarative Kongue .kg files; the old INI .conf profiles are no longer supported. Requirements Rootfs builds require Linux and root privileges. Use a disposable Kreato Linux build environment with kpkg, configured package repositories, and the native build dependencies. You also need Git, a C toolchain, Nim with Nimble, and Make. The full krep build needs native libraries including OpenSSL and libarchive. make deps installs the Nim dependencies, not the host libraries.
- JumpStart internal documentationCommunication Communication happens through UNIX sockets. /run/jumpstart.sock is the default socket path. Interacting with services The client sends these information onto the socket. { "client": { "name": "Jumpstart CLI", "version": "0.0.1-alpha" }, "service": { "name": "test.service", "action": "enable", "now": "false" } } Change the action to whatever you want. If it is supported within Jumpstart, you should see an reply. Unsupported operations are ignored. Checking the status of services Service status is sent through /run/serviceHandler/serviceName.service/status. serviceHandler serviceHandler is the service handler of JumpStart. It manages services.
