diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a3118c --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# kspice +## An opinionated system + +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! + |