Red Bear OS installer baseline from 0.1.0 pre-patched archive

2026-06-27 09:21:43 +03:00
commit 451813b2da
27 changed files with 13421 additions and 0 deletions
@@ -0,0 +1,50 @@
+# Redox OS installer
+
+The Redox installer will allow you to produce a Redox OS image. You will
+be able to specify:
+- Output device (raw image, ISO, QEMU, VirtualBox, drive)
+- Filesystem
+- Included packages
+- Method of installation (from source, from binary)
+- User accounts
+
+You will be prompted to install dependencies, based on your OS and method of
+installation. The easiest method is to install from binaries.
+
+## Usage
+
+It is recommended to compile with `cargo`, in release mode:
+```bash
+cargo build --release
+```
+
+By default, you will be prompted to supply configuration options. You can
+use the scripted mode by supplying a configuration file:
+```bash
+cargo run --release -- config/example.toml
+```
+An example configuration can be found in [config/example.toml](./config/example.toml).
+Unsuplied configuration will use the default. You can use the `general.prompt`
+setting to prompt when configuration is not set. Multiple configurations can
+be specified, they will be built in order.
+
+## Embedding
+
+The installer can also be used inside of other crates, as a library:
+
+```toml
+# Cargo.toml
+[dependencies]
+redox_installer = "0.1"
+```
+
+```rust
+// src/main.rs
+extern crate redox_installer;
+
+fn main() {    
+    let mut config = redox_installer::Config::default();
+    ...
+    redox_installer::install(config);
+}
+```