mirror of
https://git.sr.ht/~spicywolf/k2spice
synced 2025-01-18 17:59:39 +00:00
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# k2spice
|
|
## A CLA-approved opinionated userland
|
|
|
|
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.
|
|
|
|
## Goals
|
|
|
|
The first and primary goal is to build a statically-linkable, fully portable binary userland distribution not dissimilar to busybox.
|
|
|
|
The compatibility spec is considered to be the source code of the tools located in the [illumos-gate](https://github.com/illumos/illumos-gate/tree/master/usr/src/cmd) repo. Not all tools will be implemented, as they are very specific to illumos.
|
|
|
|
## Project Layout
|
|
|
|
In the root of the repo there is `Cargo.toml`, which is the workspace definition for the rest of the project. From here, you could run `cargo build` and build all the tools at once.
|
|
|
|
All source is stored in `usr/src/`. This is to comply with the CDDL license. Inside of `usr/src/` are the files/directories:
|
|
|
|
* OPENSOLARIS.LICENSE
|
|
* mei
|
|
|
|
OPENSOLARIS.LICENSE is the required CDDL license file.
|
|
|
|
The `mei` directory contains the source code for all userspace commands.
|
|
|
|
## Approved Dependency List
|
|
|
|
Currently, we are allowed to depend on the following crates and their dependencies:
|
|
|
|
- [nix](https://crates.io/crates/nix)
|
|
- [clap](https://crates.io/crates/clap)
|
|
- [serde](https://crates.io/crates/serde)
|
|
|