Official documentation for HUT OS — Hamedan University of Technology Operating System
HUT OS is a minimal, educational Linux-based operating system built to be understandable, hackable, and suitable for university OS coursework and demos.
This repository contains the canonical Markdown documentation. Source code lives in sibling repositories under the hut-os organization.
Documentation and feature lists use these labels:
| Label | Meaning |
|---|---|
| Implemented | Present in the current HUT OS tree and exercised under QEMU |
| Experimental | Present, but optional, gated, or not yet heavily hardened |
| Planned | Intended direction; not implemented yet |
| Page | Description |
|---|---|
| Getting started | Clone, build prerequisites, first boot |
| Architecture | High-level design and component map |
| Kernel | Upstream Linux + HUT OS configuration |
| Scheduler | HUTOS run-queue wait latency monitor |
| Userspace | BusyBox, Zsh, Oh My Zsh, accounts |
| Root filesystem | Layout of rootfs/ |
| Boot | Initramfs, disk, and GRUB ISO paths |
| Networking | Loopback, eth0, DHCP under QEMU |
| System tools | about, hutinfo, hutsched, BusyBox |
| Development | Local workflow and repository layout |
| Building | ./build.sh and image artifacts |
| Testing | QEMU checks and scheduler smoke tests |
| Contributing | Branches, commits, pull requests |
| Roadmap | Planned work (explicitly not done yet) |
| Repository | Role |
|---|---|
| hut-os/hut-os | Main distribution: rootfs, build scripts, patches |
| hut-os/linux-config | Kernel defconfig and scheduler patch |
| hut-os/docs | This documentation |
| hut-os/.github | Organization profile |
git clone https://github.com/hut-os/hut-os.git
cd hut-os
# Provide a kernel bzImage (see kernel.md), then:
./build.sh initramfs
./run.shInside HUT OS:
hut@hut-os:~# about
hut@hut-os:~# hutinfo
hut@hut-os:~# hutsched on
- University: Hamedan University of Technology
- Developer: Arshia Mohammadei
- Current userspace version: HUT OS 3.0.0 (
/etc/os-release) - Kernel target: Upstream Linux (documented against 7.3-rc5) with HUTOS localversion branding
Built from a dormitory study hall — named after the university.
Documentation in this repository is published for the HUT OS project. Kernel and BusyBox sources retain their upstream licenses (primarily GPL-2.0). See the main hut-os LICENSE file for project licensing.