vulcanos/README.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

2021-01-02 16:22:23 +01:00
# VulcanOS [![Build Status](https://travis-ci.com/ice-bit/vulcanos.svg?branch=master)](https://travis-ci.com/ice-bit/vulcanos)
2021-01-02 16:15:36 +01:00
**VulcanOS** is a x86 monolithic kernel written in C from scratch following the UNIX philosophy. This project is just a student learning tool to know more about operating systems, do not expect nothing more than a toy.
2021-01-04 17:54:22 +01:00
<div align="center">
<img src="imgs/screenshot.png" />
<h6><i>VulcanOS running under QEMU</h6></i>
</div><br /><br />
## Installation
### Requirements
2020-08-01 12:37:43 +02:00
Before building this project you need to setup a [cross compiler](https://wiki.osdev.org/GCC_Cross-Compiler). Also install the following packages:
- nasm
- bochs
- grub
2020-08-01 12:37:43 +02:00
- mtools(only for Arch Linux)
2020-08-01 12:37:43 +02:00
After that, you can build iceOS just by running the command listed below.
2019-09-13 18:23:19 +02:00
1. Type `make all` to compile the system and to create an ISO
2. Type `make run` to start it in QEMU or `make bochs` to start it with bochs(only for debug purposes).
2020-08-01 12:37:43 +02:00
You can also find a ISO file
2021-01-04 17:54:22 +01:00
[here](https://github.com/ice-bit/vulcanos/raw/master/imgs/vulcanos.iso)(md5sum: `a706cdfeea573e08550e599717d3f519`)
2019-07-11 00:29:36 +02:00
## Features
2020-08-01 12:37:43 +02:00
iceOS has the following features:
- [x] VGA driver
- [x] Interrupts
- [x] PIC & PIT driver
- [x] PS/2 driver
- [x] Heap
- [x] Paging
2020-08-01 14:20:16 +02:00
- [ ] VFS driver
- [ ] Usermode
2020-08-01 12:37:43 +02:00
## License
2021-01-02 16:15:36 +01:00
VulcanOS is released under GPLv3, you can obtain a copy of this license by cloning this repository or by visiting [this](https://opensource.org/licenses/GPL-3.0) page.