1
0
Fork 0
mirror of https://git.sr.ht/~spicywolf/k2spice synced 2025-01-18 17:59:39 +00:00
k2spice/README.md

32 lines
1.3 KiB
Markdown
Raw Normal View History

2023-05-19 01:44:56 +01:00
# k2spice
## A CLA-approved opinionated userland
2023-05-18 20:00:56 +01:00
This project started because I dislike GNU enough to do something about it. All of the userland tools provided can be run on any system that rust compiles to. An expanded scope showed me that I wanted very much to build lean system software to run on singleboard computers and microcontrollers, too.
## Goals
The first and primary goal is to build a statically-linkable, fully portable binary userland distribution not dissimilar to busybox.
The secondary goal is to build lean mean system software to drop on microcontrollers, specifically, the Raspberry Pi Pico.
## Project Layout
All source is stored in `usr/src/`. This is to comply with the CDDL license. Inside of `usr/src/` are the files:
* Cargo.toml
* OPENSOLARIS.LICENSE
Cargo.toml is the cargo file in which workspaces are defined. OPENSOLARIS.LICENSE is the required CDDL license file.
Additionally, there are some directories:
* mei
* kei
The `mei` directory contains the source code for all userspace commands. The `kei` directory contains the kernel source code.
## Additional Notes
Despite the Raspberry Pi foundation being on the no-no list, I have two Pico leftover from a project before the foundation went to shit. This is a small time project for my own enjoyment. If you don't wanna run it on a Pico, port it to a different platform!