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

36 lines
1.4 KiB
Markdown
Raw Normal View History

2023-05-19 01:44:56 +01:00
# k2spice
2023-11-29 15:46:30 +00:00
[![builds.sr.ht status](https://builds.sr.ht/~spicywolf/k2spice.svg)](https://builds.sr.ht/~spicywolf/k2spice?)
2023-05-19 01:44:56 +01:00
## A CLA-approved opinionated userland
2023-05-18 20:00:56 +01:00
2023-11-14 03:49:21 +00: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.
2023-05-18 20:00:56 +01:00
## Goals
The first and primary goal is to build a statically-linkable, fully portable binary userland distribution not dissimilar to busybox.
2023-11-14 04:15:45 +00:00
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.
2023-05-18 20:00:56 +01:00
## Project Layout
2023-11-14 03:54:05 +00:00
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:
2023-05-18 20:00:56 +01:00
* OPENSOLARIS.LICENSE
2023-11-14 03:54:05 +00:00
* mei
2023-05-18 20:00:56 +01:00
2023-11-14 03:54:05 +00:00
OPENSOLARIS.LICENSE is the required CDDL license file.
2023-05-18 20:00:56 +01:00
2023-11-14 03:49:21 +00:00
The `mei` directory contains the source code for all userspace commands.
2023-05-18 20:00:56 +01:00
2023-11-14 16:15:39 +00:00
## 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)