Update README and installer for BasaltOS 0.1.0 release

Author: NoryiE

.github/workflows/update-install-manifest.yml

@@ -0,0 +1,87 @@
+name: Update install manifest
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "os/**"
+      - ".github/workflows/update-install-manifest.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: update-install-manifest
+  cancel-in-progress: true
+
+jobs:
+  update:
+    name: Generate install-manifest.txt
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Generate manifest
+        shell: python
+        run: |
+          from pathlib import Path
+          import re
+
+          root = Path("os")
+          output = Path("install-manifest.txt")
+          allowed_path = re.compile(r"^os/[A-Za-z0-9._/-]+$")
+
+          if not root.is_dir():
+              raise SystemExit("The os directory does not exist.")
+
+          def is_runtime_path(path: str) -> bool:
+              return (
+                  path == "os/system/config.dat"
+                  or path.startswith("os/system/logs/")
+                  or path.startswith("os/users/")
+              )
+
+          entries = []
+          for file in sorted(path for path in root.rglob("*") if path.is_file()):
+              relative = file.as_posix()
+              if is_runtime_path(relative):
+                  continue
+              if not allowed_path.fullmatch(relative):
+                  raise SystemExit(f"Unsupported installer path: {relative}")
+              if any(part in {".", ".."} for part in file.parts):
+                  raise SystemExit(f"Unsafe installer path: {relative}")
+              entries.append(f"{relative}|{file.stat().st_size}")
+
+          if not entries:
+              raise SystemExit("No installable BasaltOS files were found.")
+
+          content = "\n".join([
+              "# BasaltOS installation manifest v1",
+              "# Format: repository path|size in bytes",
+              "# Generated by .github/workflows/update-install-manifest.yml",
+              "# Runtime state such as users, logs, and system/config.dat is intentionally excluded.",
+              *entries,
+              "",
+          ])
+          output.write_text(content, encoding="utf-8", newline="\n")
+          print(f"Generated {len(entries)} entries in {output}.")
+
+      - name: Commit updated manifest
+        shell: bash
+        run: |
+          if [ -z "$(git status --porcelain -- install-manifest.txt)" ]; then
+            echo "install-manifest.txt is already up to date."
+            exit 0
+          fi
+
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add install-manifest.txt
+          git commit -m "chore: update install manifest"
+          git push

README.md

@@ -1,66 +1,141 @@
 # BasaltOS
 
-A lightweight, public operating system for ComputerCraft, inspired by Basalt.
-
-Overview
-- BasaltOS is a modular, minimal OS built on Basalt UI components. It's intended as a starting point for building and testing apps and UI features in a ComputerCraft environment.
-
-Key Features
-- App launcher and startup script (`startup.lua`)
-- Organized system layout under `system/` and `apps/`
-- Basalt UI library inside `lib/public/basalt/` for rapid UI development
-- Logging and service modules in `logs/` and `services/`
-- Shared binary [FLIMG v1](system/lib/public/FLIMG.md) images with RGB palettes,
-  2x3 subpixels, layers, animation timing, RAW/RLE blocks and frame deltas
-- FLIMG Studio under `system/apps/flimgstudio` for lossless pixel/cell editing,
-  palettes, layers, timelines and BIMG/OSF import
-
-Developing
-- Apps: Create a new folder in `apps/` with an `app.json` and `main.lua` to register an app.
-- Plugins/Themes: Extend or modify items in `lib/public/basalt/plugins/`.
-- Debugging: Check `logs/` for runtime messages and `services/` for service status.
-
-Basalt render pacing
-- `basalt.setRenderInterval(seconds)` limits automatic render passes while
-  continuing to process every input event. Rapid invalidations are coalesced
-  and a trailing timer guarantees that the newest state is rendered.
-- `basalt.getRenderInterval()` returns the configured interval.
-- `basalt.flush()` immediately renders pending changes. An interval of `0`
-  restores render-after-every-event behavior.
-- BasaltOS uses an interval of `0.05` seconds (at most 20 automatic renders
-  per second).
-
-Filely file icons
-- An app associated with a file type may declare a colored 1x1 icon in `app.json`:
-  `"file_icon": {"char": 131, "fg": "white", "bg": "lightBlue"}`.
-- `char` is a ComputerCraft character code from 0 to 255; `fg` and `bg` are optional `colors.*` names or values.
-- A missing `fg` or `bg` uses Filely's current row background. The legacy `color` field is accepted as an alias for `bg`.
-- Filely renders the glyph as a subpixel icon. Files without a declared icon use character 131 in light gray; folders use character 131 in yellow.
-
-System-wide file operations
-- Apps can access the `fileops` service through `require("app").fileops`.
-- `fileops.copy(path)` and `fileops.cut(path)` place a typed file selection on the shared clipboard.
-- `fileops.paste(directory)` copies or moves it, choosing a friendly unique name when the target already exists.
-- `fileops.canPaste(directory)` and `fileops.getClipboardInfo()` allow UIs to present the same actions as Filely and the desktop.
-
-Basalt Store
-- The versioned [Basalt Store catalog format](BASALT_STORE_CATALOG.md) lists every app and its explicit GitHub-hosted files without using the GitHub API.
-- The `basaltstore` service validates and caches the catalog per user, retaining the last good catalog for offline use.
-- Store installs are staged, matched against the catalog ID/version, and handed to the Registry only after every declared file is present.
-
-Window close requests
-- Managed apps can register `window.setCloseHandler(function(resolve) ... end)`.
-- Call `resolve(true)` to allow the close or `resolve(false)` to cancel it. The callback may answer later, so confirmation dialogs can be asynchronous.
-- `window.setCloseHandler(nil)` removes the handler. While a request is pending, repeated close clicks are coalesced.
-- Process termination, including Task Manager's `End task`, forcibly closes the window and bypasses the handler.
-
-Contributing
-- Contributions are welcome. Open issues or PRs with a brief description and reproduction steps or screenshots when applicable.
-
-License
-- See `LICENSE` for license details.
-
-Contact
-- For questions or feedback, open an issue or contact the maintainer via the repository.
-
-Enjoy building with BasaltOS!
+BasaltOS is a desktop operating system for
+[CC:Tweaked](https://tweaked.cc/) built with
+[Basalt 2.5](https://github.com/Pyroxenium/Basalt2/tree/basalt2.5).
+It combines a familiar windowed desktop with a modular service and app
+architecture designed specifically for ComputerCraft.
+
+> BasaltOS is currently an early preview (`0.1.0`).
+
+## Highlights
+
+- Window manager with movable, resizable and focus-aware application windows
+- Desktop, taskbar, start menu, launcher and system notifications
+- Local user accounts with separate home directories and settings
+- Shared clipboard, drag and drop, file operations and file associations
+- Basalt Store for discovering and installing additional applications
+- Device Manager for inspecting attached ComputerCraft peripherals
+- Built-in support for Basalt 2.5, Obsidian and FLIMG-based images
+- Service-oriented internals with isolated application environments
+
+## Included applications
+
+BasaltOS ships with a practical starter set:
+
+- **Filely** — file manager with copy, cut, paste and app associations
+- **Terminal** and **Shell** — graphical and native command-line access
+- **Notepad** and **Editor** — text editing and source-code workflows
+- **Calculator** and **Calendar** — compact offline utilities
+- **Settings** — appearance and system configuration
+- **Task Manager** — inspect, focus, pause and terminate processes
+- **Device Manager** — inspect connected peripherals
+- **Basalt Store** — browse and install BasaltOS applications
+- **Paint**, **Image Viewer** and **Pastebin** integrations
+
+## Requirements
+
+- An Advanced Computer running a current version of CC:Tweaked
+- A terminal resolution of at least `51x19`
+- The HTTP API enabled
+- Approximately 1.5 MB of installed storage
+- Approximately 1.5 MB of additional free space while installing or updating
+
+The default ComputerCraft computer storage limit may be too small. If the
+installer reports insufficient space, increase the computer space limit in
+your CC:Tweaked or CraftOS-PC configuration before continuing.
+
+## Installation
+
+Run this command from the CraftOS shell:
+
+```shell
+wget run https://raw.githubusercontent.com/Pyroxenium/BasaltOS/refs/heads/main/install.lua
+```
+
+The installer downloads the current release, stages it before making changes,
+and installs BasaltOS into the computer root. It preserves:
+
+- Existing local users and their files under `/users`
+- Machine configuration in `/system/config.dat`
+- Runtime logs under `/system/logs`
+- The previous `startup.lua`, saved as `startup.before-basaltos.lua`
+
+If applying the installation fails, files already changed during that attempt
+are restored automatically. After installation, select **Reboot** to enter
+BasaltOS.
+
+On the first boot, BasaltOS asks you to create the first local administrator.
+There is no default username or password.
+
+### Updating
+
+Run the same installation command again. The installer replaces system files
+while retaining local accounts, user data and configuration.
+
+## Developing applications
+
+Applications live in `/system/apps/<app-id>/` and normally contain:
+
+```text
+myapp/
+├── app.json
+├── main.lua
+├── icon.bimg
+└── taskbar.bimg
+```
+
+A minimal `app.json` looks like this:
+
+```json
+{
+  "id": "myapp",
+  "name": "My App",
+  "version": "1.0.0",
+  "description": "A BasaltOS application",
+  "author": "Your Name",
+  "category": "utilities",
+  "executable": "main.lua",
+  "singleton": false,
+  "window": {
+    "fullscreen": false,
+    "resizable": true,
+    "default_width": 32,
+    "default_height": 12,
+    "min_width": 20,
+    "min_height": 8
+  }
+}
+```
+
+Inside an app, `require("app")` exposes the public BasaltOS services. Basalt,
+Obsidian and FLIMG are available from the public library directory.
+
+The most relevant project directories are:
+
+```text
+os/
+├── startup.lua
+└── system/
+    ├── apps/       Built-in applications
+    ├── assets/     Shared icons and visual assets
+    ├── core/       Kernel and core APIs
+    ├── lib/public/ Public application libraries
+    └── services/   Desktop and operating-system services
+```
+
+The installer reads `install-manifest.txt`. A GitHub Actions workflow
+regenerates and commits it automatically whenever files under `os/` change.
+Runtime state (`users`, logs and `system/config.dat`) is intentionally excluded.
+
+## Contributing
+
+Bug reports and pull requests are welcome. Please include clear reproduction
+steps and screenshots for visual issues where possible:
+
+- [Report an issue](https://github.com/Pyroxenium/BasaltOS/issues)
+- [Open a pull request](https://github.com/Pyroxenium/BasaltOS/pulls)
+
+## License
+
+BasaltOS is released under the [MIT License](LICENSE).