{"id":13599865,"url":"https://github.com/RWTH-OS/eduOS-rs","last_synced_at":"2025-04-10T17:32:50.462Z","repository":{"id":44687524,"uuid":"78310497","full_name":"RWTH-OS/eduOS-rs","owner":"RWTH-OS","description":"A teaching operating system written in Rust","archived":false,"fork":false,"pushed_at":"2025-03-24T16:48:53.000Z","size":9037,"stargazers_count":447,"open_issues_count":5,"forks_count":28,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-04-03T06:09:45.160Z","etag":null,"topics":["eduos-rs","kernel","operating-system","rust"],"latest_commit_sha":null,"homepage":"https://rwth-os.github.io/eduOS-rs/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RWTH-OS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-07T23:43:40.000Z","updated_at":"2025-03-27T09:23:41.000Z","dependencies_parsed_at":"2023-01-24T08:16:06.253Z","dependency_job_id":"2576464e-f992-4510-a151-4dc852739c0a","html_url":"https://github.com/RWTH-OS/eduOS-rs","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-OS%2FeduOS-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-OS%2FeduOS-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-OS%2FeduOS-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-OS%2FeduOS-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RWTH-OS","download_url":"https://codeload.github.com/RWTH-OS/eduOS-rs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248261995,"owners_count":21074229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eduos-rs","kernel","operating-system","rust"],"created_at":"2024-08-01T17:01:14.372Z","updated_at":"2025-04-10T17:32:50.455Z","avatar_url":"https://github.com/RWTH-OS.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"![Actions Status](https://github.com/RWTH-OS/eduOS-rs/workflows/Build/badge.svg)\n\n# eduOS-rs - A teaching operating system written in Rust\n\n## Introduction\n\neduOS-rs is a Unix-like operating system based on a monolithic architecture for educational purposes.\nIt is developed for the course [Operating Systems][acsos] at RWTH Aachen University.\neduOS-rs is derived from following tutorials and software distributions:\n\n1. Philipp Oppermann's [excellent series of blog posts][opp].\n2. Erik Kidd's [toyos-rs][kidd], which is an extension of Philipp Opermann's kernel.\n3. The original version of [eduOS][stlankes], which was the old teaching kernel written in C.\n4. eduOS-rs' uses a memory allocator, which is derived from the [buddy_system_allocator][buddy].\n5. The first version of paging is derived from a version, which was developed by [Colin Finck][colin].\n\n[opp]: http://blog.phil-opp.com/\n[kidd]: http://www.randomhacks.net/bare-metal-rust/\n[stlankes]: http://rwth-os.github.io/eduOS/\n[rust-barebones-kernel]: https://github.com/thepowersgang/rust-barebones-kernel\n[acsos]: https://www.acs.eonerc.rwth-aachen.de/cms/e-on-erc-acs/studium/lehrveranstaltungen/~xwyom/grundgebiete-der-informatik-4-betriebs/?lidx=1\n[colin]: https://github.com/ColinFinck\n[buddy]: https://github.com/rcore-os/buddy_system_allocator\n\n## Requirements to build eduOS-rs\neduOS-rs is tested under Linux, macOS, and Windows.\n\n### macOS\nApple's *Command Line Tools* must be installed.\nThe Command Line Tool package gives macOS terminal users many commonly used tools and compilers, that are usually found in default Linux installations.\nFollowing terminal command installs these tools without Apple's IDE Xcode:\n\n```sh\n$ xcode-select --install\n```\n\nIn addition, *Qemu* must be installed.\nPlease use [Homebrew](https://brew.sh) as package manager to install Qemu.\n\n```sh\n$ brew install qemu \n```\n\n### Windows\nTo build eduOS-rs you have to install _Qemu_ and a git client.\nPlease use [Chocolatey](https://chocolatey.org) as package manager to install Qemu and git.\n\n```sh\n$ choco install qemu git\n```\n\n### Linux\nLinux users should install common developer tools.\nFor instance, on Ubuntu 22.04 the following command installs the required tools:\n\n```sh\n$ apt-get install -y git qemu-system-x86 build-essential\n```\n\n### Common for macOS, Windows and Linux\nThis project uses Rustup to set its Rust toolchain.\nFollow the instructions to [install Rust using Rustup](https://www.rust-lang.org/tools/install).\n\nIn addition, the tool [bootimage](https://github.com/rust-osdev/bootimage) is required, which creates a bootable diskimage.\nPlease install the tool with following command.\n\n```sh\n$ cargo install bootimage\n```\n\n## Building\n\neduOS-rs is able to run within [Qemu](https://www.qemu.org), which is a generic and open source machine emulator and virtualizer.\n\nAfter cloning the repository, you can run the kernel with following command:\n\n```sh\n$ cargo run\n```\n\n## Overview of all branches\n\nStep by step (here branch by branch) the operating system design will be introduced.\nThis tutorial shows the steps to develop from a minimal kernel to a Unix-like computer operating system.\nCurrently, following stages of development are available:\n\n0. stage0 - Smallest HelloWorld of the World\n\n   Description of loading a minimal 64bit kernel\n\n1. stage1 - Cooperative/non-preemptive multitasking\n\n   Introduction into a simple form of multitasking, where no interrupts are required.\n\n2. stage2 - Priority-based cooperative/non-preemptive multitasking\n\n   Introduction into a simple form of priority-based multitasking, where no interrupts are required.\n\n3. stage3 - Synchronization primitives\n\n   Introduce basic synchronization primitives\n\n4. stage 4 - Preemptive multitasking\n\n   Introduction into preemptive multitasking and interrupt handling\n\n5. stage 5 - Support of user-level tasks\n\n   Add support of user-level tasks with an small interface for basic system calls\n\n6. stage 6 - Support of paging\n\n   Add support of paging and a simple demo for process creation\n\n7. stage 7 - Basic IO interface\n\n   Add basic support of file descriptors\n\n8. stage 8 - Integration of an in-memory file system\n\n   Introduce a virtual file system with an in-memory file system as example file system.\n\n9. stage9 - Run Linux application as common process\n\n   Start a simple Linux application (_HelloWorld_) on top of eduOS-rs. The application is a _position-independent executable_ (PIE) and use [musl-libc](http://www.musl-libc.org) as standard C library. The FPU support is disabled.\n\n## Useful Links\n\n1. [http://www.gnu.org/software/grub/manual/multiboot/](http://www.gnu.org/software/grub/manual/multiboot/)\n2. [http://www.osdever.net/tutorials/view/brans-kernel-development-tutorial](http://www.osdever.net/tutorials/view/brans-kernel-development-tutorial)\n3. [https://www.acs.eonerc.rwth-aachen.de/cms/e-on-erc-acs/studium/lehrveranstaltungen/~xwyom/grundgebiete-der-informatik-4-betriebs/?lidx=1](https://www.acs.eonerc.rwth-aachen.de/cms/e-on-erc-acs/studium/lehrveranstaltungen/~xwyom/grundgebiete-der-informatik-4-betriebs/?lidx=1)\n4. [http://rwth-os.github.io/eduOS/](http://rwth-os.github.io/eduOS/)\n5. [https://intermezzos.github.io](https://intermezzos.github.io)\n\n## License\n\nLicensed under either of\n\n * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRWTH-OS%2FeduOS-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRWTH-OS%2FeduOS-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRWTH-OS%2FeduOS-rs/lists"}