https://github.com/iamthenerdnextdoor/arikoto

Arikoto is a personal OS project that is inspired by and is aiming to have a similar nature to ToaruOS.
https://github.com/iamthenerdnextdoor/arikoto

c cmake hobby-os kernel limine low-level operating-system os osdev x86 x86-64

Last synced: 12 days ago
JSON representation

Arikoto is a personal OS project that is inspired by and is aiming to have a similar nature to ToaruOS.

• Host: GitHub
• URL: https://github.com/iamthenerdnextdoor/arikoto
• Owner: IAmTheNerdNextDoor
• Created: 2024-10-10T12:27:47.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2025-04-11T10:40:36.000Z (14 days ago)
• Last Synced: 2025-04-11T12:05:36.589Z (14 days ago)
• Topics: c, cmake, hobby-os, kernel, limine, low-level, operating-system, os, osdev, x86, x86-64
• Language: C
• Homepage: http://arikoto.nerdnextdoor.net/
• Size: 2.29 MB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Arikoto (ありこと)

[![CodeQL Runner](https://github.com/AFellowSpeedrunner/arikoto/actions/workflows/codeql.yml/badge.svg)](https://github.com/AFellowSpeedrunner/arikoto/actions/workflows/codeql.yml) ![loc](https://tokei.rs/b1/github/IAmTheNerdNextDoor/arikoto)

Arikoto is my personal Operating System development project that is inspired by and is aiming to have a similar nature to [ToaruOS](https://github.com/klange/toaruos).

## Features

- Written in C/inline and normal Assembly

- 64-bit

- UEFI + BIOS support

- Limine boot protocol

- Memory

- VFS/Ramdisk (not external yet)

- CMake Build System

- Keyboard

- Shell

- GDT

- IDT

- PIC

- Timer

- ISR (Partial)

- IRQ (Partial)

## Building

### Linux

Run `mkdir build && cd build` in the Arikoto root folder. Type `cmake ..`. The project will be configured automatically.

From here, you can type `make`, `make run`, `make run-kvm`, `make run-uefi` and (my favourite) `make run-uefi-kvm`.

Running `make clean` wipes built binaries and arikoto.iso if an image was built. Running `make distclean` wipes the `limine/`, `ovmf/`, `kernel/cc-runtime/`, `kernel/freestnd-c-hdrs-0bsd/` and `build/` folders and deletes `kernel/include/limine.h`.

### macOS

If you are on macOS, you will need to install Linux. If you are not building on Linux and are instead using macOS, do not expect any support for problems that are encountered.

### Windows

While really not recommended, you could use WSL. I still recommend you use Linux natively to build Arikoto.

## Contributions

While Arikoto is my personal OS project, bugfixes would help a lot. Major changes to functionality or new features to be added should be discussed first.

- [Discord Server](https://discord.gg/UczSZb7s7B)

- [GitHub Issues](https://github.com/IAmTheNerdNextDoor/arikoto/issues)

- [GitHub Discussions](https://github.com/IAmTheNerdNextDoor/arikoto/discussions)

- [Zed Collab](https://zed.dev/channel/Arikoto-19596)