Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aurixos/os

AurixOS kernel
https://github.com/aurixos/os

c kernel operating-system osdev x86-64

Last synced: 3 months ago
JSON representation

AurixOS kernel

Host: GitHub
URL: https://github.com/aurixos/os
Owner: aurixos
License: mit
Created: 2024-04-05T13:19:50.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-04-26T11:26:36.000Z (10 months ago)
Last Synced: 2024-04-26T11:48:38.746Z (10 months ago)
Topics: c, kernel, operating-system, osdev, x86-64
Language: C
Homepage:
Size: 827 KB
Stars: 4
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SECURITY.md

Awesome Lists containing this project

awesome-os - AurixOS - A small multiplatform Operating System designed for developers and creators (Open Source Operating Systems)

README

        


  

    

  





  AurixOS

  


  


  Report a Bug

  ·

  Request a Feature

  .

  Ask a Question








[![Project license](https://img.shields.io/github/license/aurixos/os.svg?style=flat-square)](LICENSE)

[![Discord Chat](https://img.shields.io/discord/1234051470182055988)](https://discord.com/invite/hgbZ6wFP4n)



Table of Contents

- [About](#about)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Building](#building)

- [Running](#running)

- [Support](#support)

- [Contributing](#contributing)

- [Authors & contributors](#authors--contributors)

- [Security](#security)

- [License](#license)

- [Acknowledgements](#acknowledgements)

---

## About

AurixOS is a general-purpose operating system, meant to take security, performance and usability to the next level.

## Getting Started

Latest official releases of AurixOS are available for download [here](https://github.com/aurixos/os/releases).

### Prerequisites

If you have [Homebrew](https://brew.sh) installed, simply run `brew bundle` to install **all** required build dependencies (incl. packages to build AurixOS for every supported architecture).

Alternatively, read the [Brewfile](Brewfile) in the root of this repository and install the required (and optional) packages manually.

### Building

To build AurixOS, simply run `make` in the root directory of this repository.

To change the build architecture, run `make ARCH=arch`, where `arch` is the target architecture (Default is set to `x86_64`).

Building AurixOS images is also supported with Make recipes:

- `livecd` builds a CD-ROM image (.iso)

- `livehdd` builds a HDD image (.img)

All images reside in the `release/` directory and follow this naming scheme:

`aurixos-live[MEDIA]-[GIT_REV]_[ARCH].iso`

`make help` shows you all available build options

## Running

To run AurixOS on QEMU, run `make run` (optionally, append `ARCH=arch` if you're building/running AurixOS on an architecture other than x86_64).

Alternatively, you can boot AurixOS on a physical machine by running `dd if=release/.img of=/dev/ bs=1M` and booting off of this USB drive.

## Support

If you have any questions, feel free to open a [GitHub issue](https://github.com/aurixos/os/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+).

Alternatively, you can visit us:

- on our [Discord server](https://discord.com/invite/hgbZ6wFP4n)

- on #aurixos at [irc.libera.chat](https://libera.chat/) ([Kiwi IRC](https://kiwiirc.com/client/irc.libera.chat/?&theme=cli#aurixos))

## Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.

Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved!

## Authors & contributors

For a full list of all authors and contributors, see [the contributors page](https://github.com/aurixos/os/contributors).

## Security

AurixOS follows good practices of security, but 100% security cannot be assured.

AurixOS is provided **"as is"** without any **warranty**. Use at your own risk.

_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._

## License

This project is licensed under the **MIT license**.

See [LICENSE](LICENSE) for more information.

## Acknowledgements

- [The Standard C Library by P. J. Plauger](https://www.amazon.com/Standard-C-Library-P-J-Plauger/dp/0131315099)

- [Soapine Bootloader](https://github.com/Sipaa-Projects/Soapine)