Add start of nbuild tool.

Author: thejpster

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+nbuild = "run --manifest-path nbuild/Cargo.toml --"

.gitignore

@@ -1,3 +1,4 @@
+/nbuild/target
 /target
 **/*.rs.bk
 /release

.vscode/settings.json

@@ -1,4 +1,7 @@
 {
     "rust-analyzer.checkOnSave.allTargets": false,
-    "rust-analyzer.cargo.target": "thumbv6m-none-eabi"
+    "rust-analyzer.linkedProjects": [
+        "./Cargo.toml",
+        "./nbuild/Cargo.toml"
+    ]
 }

Cargo.lock

@@ -4,6 +4,9 @@ members = [
     "utilities/flames",
 ]
 resolver = "2"
+exclude = [
+    "nbuild"
+]
 
 [workspace.dependencies]
 neotron-sdk = "0.2.0"

Cargo.toml

@@ -14,14 +14,16 @@ This OS is a work in progress. We intend to support:
 * [x] Executing applications from RAM
   * [x] Applications can print to stdout
   * [x] Applications can read from stdin
-  * [ ] Applications can open/close/read/write files
+  * [x] Applications can open/close/read files
+  * [ ] Applications can write to files
 * [x] MBR/FAT32 formatted block devices
   * [x] Read blocks
   * [x] Directory listing of /
   * [ ] Write to files
   * [ ] Delete files
   * [ ] Change directory
 * [x] Load ELF binaries from disk
+* [x] Load ELF binaries from ROM
 * [x] Changing text modes
 * [ ] Basic networking
 * [x] Music playback
@@ -35,50 +37,13 @@ Your board will need an appropriate Neotron BIOS installed, and you need to have
 OpenOCD or some other programming tool running for your particular board. See
 your BIOS instructions for more details.
 
-We compile one version of Neotron OS, but we link it three times to produce
-three different binaries:
+Building Neotron OS is handled by the `nbuild` tool, in this repository.
 
-* `flash0002` - is linked to run from address `0x0002_0000`
-* `flash1002` - is linked to run from address `0x1002_0000`
-* `flash0802` - is linked to run from address `0x0802_0000`
+Run `cargo nbuild help` for more information.
 
-```console
-$ git clone https://github.com/neotron-compute/Neotron-OS.git
-$ cd Neotron-OS
-$ cargo build --target thumbv6m-none-eabi --release --bins
-$ ls ./target/thumbv6m-none-eabi/release/flash*02
-./target/thumbv6m-none-eabi/release/flash0002 ./target/thumbv6m-none-eabi/release/flash0802 ./target/thumbv6m-none-eabi/release/flash1002
-```
-
-Your BIOS should tell you which one you want and how to load it onto your system.
+Your BIOS should tell you which options to pass, and how to load the resulting image onto your system.
 
-You can also build a *shared object* to load into a Windows/Linux/macOS application.
-
-```console
-$ cargo build --lib
-$ ls ./target/debug/*.so
-./target/debug/libneotron_os.so
-```
-
-If you want to include a ROMFS, you need to:
-
-```bash
-cargo install neotron-romfs-lsfs
-cargo install neotron-romfs-mkfs
-cargo install cargo-binutils
-```
-
-A bunch of utilities are supplied in the [`utilities`](./utilities/) folder. Build them all, and make a ROMFS image, then build the OS with the `ROMFS_PATH` environment variable set.
-
-```bash
-TGT=$(pwd)/target/thumbv6m-none-eabi/release
-cargo build --bin flames --target thumbv6m-none-eabi --release
-rust-strip ${TGT}/flames -o ${TGT}/flames.elf
-neotron-romfs-mkfs ${TGT}/flames.elf > ${TGT}/romfs.img
-ROMFS_PATH=${TGT}/romfs.img cargo build --bin flash1002 --target thumbv6m-none-eabi --release
-```
-
-The OS will then include the ROMFS image, which you can access with the `rom` command.
+Programs in the ROMFS can be loaded with:
 
 ```text
 > rom
@@ -93,14 +58,22 @@ Loading 4908 bytes to 0x200022b4
 
 A better UI for loading files from ROM is being planned (maybe we should have drive letters, and the ROM can be `R:`).
 
+You can also build a *shared object* to load into a Windows/Linux/macOS application, like [Neotron Desktop BIOS](https://github.com/neotron-compute/neotron-desktop-bios): 
+
+```console
+$ cargo nbuild library
+$ ls ./target/debug/*.so
+./target/debug/libneotron_os.so
+```
+
 ## Changelog
 
 See [`CHANGELOG.md`](./CHANGELOG.md)
 
 ## Licence
 
 ```text
-Neotron-OS Copyright (c) Jonathan 'theJPster' Pallant and The Neotron Developers, 2023
+Copyright (c) 2019-2024 Jonathan 'theJPster' Pallant and The Neotron Developers
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

README.md

@@ -0,0 +1,15 @@
+[package]
+name = "nbuild"
+version = "0.1.0"
+edition = "2021"
+authors = [
+    "Jonathan 'theJPster' Pallant <github@thejpster.org.uk>",
+    "The Neotron Developers"
+]
+description = "The Neotron Operating System Build System"
+license = "GPL-3.0-or-later"
+readme = "README.md"
+repository = "https://github.com/neotron-compute/Neotron-OS"
+
+[dependencies]
+clap = { version = "4.5.23", features = ["derive"] }

nbuild/Cargo.lock

@@ -0,0 +1,12 @@
+# nbuild - the Neotron OS Build System
+
+Building Neotron OS involves:
+
+* Compiling the Neotron OS source code
+* Compiling and linking multiple Neotron OS utilities
+* Assembling the utilities into a ROMFS image
+* Linking the Neotron OS object code, including the ROMFS image
+
+This utility automates that process.
+
+Run `cargo nbuild --help` from the top level of the checkout for more information.