{"id":26111505,"url":"https://github.com/erik-donath/sodium","last_synced_at":"2025-06-16T03:39:05.222Z","repository":{"id":257584224,"uuid":"829042811","full_name":"Erik-Donath/Sodium","owner":"Erik-Donath","description":"An small x86 Operating System which uses multiboot2 and the grub bootloader.","archived":false,"fork":false,"pushed_at":"2025-01-15T17:03:58.000Z","size":288,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T16:48:18.919Z","etag":null,"topics":["boot","grub","i686","kernel","multiboot2","operating-system","os","uefi-boot","x86"],"latest_commit_sha":null,"homepage":"https://github.com/Erik-Donath/Sodium/","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Erik-Donath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-15T16:30:47.000Z","updated_at":"2025-03-03T21:47:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"e13c40fd-2b30-460c-8d9f-c63fff080aa0","html_url":"https://github.com/Erik-Donath/Sodium","commit_stats":null,"previous_names":["erik-donath/sodium"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erik-Donath%2FSodium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erik-Donath%2FSodium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erik-Donath%2FSodium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erik-Donath%2FSodium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Erik-Donath","download_url":"https://codeload.github.com/Erik-Donath/Sodium/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248643045,"owners_count":21138353,"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":["boot","grub","i686","kernel","multiboot2","operating-system","os","uefi-boot","x86"],"created_at":"2025-03-10T01:52:00.556Z","updated_at":"2025-06-16T03:39:05.211Z","avatar_url":"https://github.com/Erik-Donath.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sodium\n\nAn small, hobbyist-grade  x86 operating  system which uses  Multiboot2\nwith the GRUB bootloader.\n\n\u003e Warning: This sytem  is still in early development.  Many things can\n\u003e (and probably will) go wrong.\n\n## What is an Operating System\n\n![EX1](EX1.png)\n\n## Building on Windows (Release 10 \u0026 11)\n\nVisit [QEMU's website](https://www.qemu.org/) and install the binaries\nby *Stefan Weil*.\n\nOpen a command-line and install the  Docker containerization system by\nrunning the command:\n\n```\nwinget install Docker.DockerDesktop\n```\n\nTo  build the operating  system, the following  command  should be run\n*but* `PROJECT_PATH` should  be replaced with  the full, absolute path\nat which the project resides.\n\n```\ndocker run --rm -it -v PROJECT_PATH:/root/env sodium-buildenv\n```\n\n## Building on Debian Linux\n\nInstall Docker by running the following command as super-user:\n\n```Bash\napt install docker qemu\n```\n\nCreate the build environment  container by running the following (with\nsuper-user permissions):\n\n```Bash\ndocker buildx build buildenv -t sodium-os:buildenv\n```\n\nBuild the project using the newly-created container with:\n\n```Bash\nsudo docker run --rm -it -v ./:/root/env:Z sodium-buildenv\n```\n\n## Running\n\nIf no error was  produced by the previous command, it  now is possible\nto run the operating system using:\n\n```Bash\nqemu-system-x86_64 -debugcon stdio -cdrom dist/Sodium.iso\n```\n\nYou can also run the OS by using the `.iso` file directly (For example\nin VirtualBox or on a flash drive).\n\n## Folder Structure\n\nThe following is an overview of Sodium's current folder structure:\n\n- `buildenv/`\n  - `docker-entrypoint.sh`\n  - `Dockerfile`\n- `src/`\n  - `kernel/`  \n    Contains all sources of the kernel and its drivers.\n    - `arch/i686/`\n      - *i686 Driver and Systems*\n  - `boot/i686/`\n    - `boot.asm`\n    - `multiboot.inc`\n    - `shutdown.asm`\n    - `grub/`\n      - `grub.cfg`\n  - `linker.ld`\n- `dist/`  \n  Contains the output file; the file produced by the build script.\n  - `Sodium.iso`\n- `kernel.bin`\n- `build/`  \n  Contains intermediate (object code) files used to build the system.\n- `Makefile`\n- `README.md`\n- `LICENSE`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferik-donath%2Fsodium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferik-donath%2Fsodium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferik-donath%2Fsodium/lists"}