https://github.com/enderice2/fennix

Opeating System from scratch made in C and C++
https://github.com/enderice2/fennix

aarch64 arm assembly c cpp cpp20 gcc-compiler gcc-cross-compiler kernel operating-system operating-system-learning os os-development osdev osdev-projects x86 x86-64

Last synced: 7 months ago
JSON representation

Opeating System from scratch made in C and C++

• Host: GitHub
• URL: https://github.com/enderice2/fennix
• Owner: EnderIce2
• License: gpl-3.0
• Created: 2024-11-20T02:32:33.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-01-24T13:28:32.000Z (about 1 year ago)
• Last Synced: 2025-01-24T14:27:41.097Z (about 1 year ago)
• Topics: aarch64, arm, assembly, c, cpp, cpp20, gcc-compiler, gcc-cross-compiler, kernel, operating-system, operating-system-learning, os, os-development, osdev, osdev-projects, x86, x86-64
• Language: C++
• Homepage: http://fennix.enderice2.com/
• Size: 75 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          




Fennix Operating System





 


        

    

    

    

 


Fennix is an operating system built from scratch using C and C++.


---

> [!CAUTION]

> The project is still in development and is not yet ready for production use.

>

> Please use a virtual machine to run the OS.

## Features

- 🧩 Flexible and modular

    - You can easily choose the components you want to include in the kernel

- 🎛️ Compatible with multiple platforms

    - Supports i386, AMD64 and AArch64 platforms

- 📦 Support for different operating system binaries

    - You can run Linux and Windows binaries

- 🖨️ Driver support

    - Supports a variety of drivers for different hardware components

- 📖 Detailed documentation

    - The project is well-documented using Doxygen

> [!IMPORTANT]

> Some features are still in development and may not be fully functional.

## Getting Started

### 💾 Download ISO Image

You can download the development ISO image from the [Actions](https://github.com/EnderIce2/Fennix/actions/workflows/makefile.yml) tab on the GitHub repository.

### 🛠️ Compile from Source

Check out the [installation guide](INSTALL.md) to compile the project from source.

## 📚 Documentation

The current documentation is available [here](https://fennix.enderice2.com/docs/index.html).

To generate the documentation, run:

```sh

make docs

```

The documentation will be available in the `doxygen-doc/docs` directory.

## 👨‍💻 Contributing

Contributions are welcome!  

Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to this project.

### Contributors



    



## 📃 License

Fennix is licensed under the GNU General Public License v3.0.

See the [LICENSE.md](LICENSE.md) file for more details.

Other licenses used in the project can be found in the [LICENSES.md](LICENSES.md) file.