Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arakis authored Oct 28, 2019
1 parent c5c1b8a commit 48b2b54
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,17 @@
[![Join the chat at https://gitter.im/abanu-org/abanu](https://badges.gitter.im/abanu-org/abanu.svg)](https://gitter.im/abanu-org/abanu?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Join Discord https://discord.gg/dZVMBnE](https://img.shields.io/discord/638041194408181770?logo=discord)](https://discord.gg/dZVMBnE)

## About Abanu

Abanu is a proof of concept Operating System written in C#.

## Getting the Sources

Visit the official repository [https://github.com/abanu-org/abanu](https://github.com/abanu-org/abanu)

## Build instructions

#### Quick Start (recommended)

Follow these instructions: [http://docs.abanu.org/en/latest/build.html](http://docs.abanu.org/en/latest/build.html)

#### Manually

Prerequisites:
- .NET Framework 4.7.2 or latest Mono
- NASM Assembler (`sudo apt-get install nasm`)
- mtools (`sudo apt-get install mtools`)
- xorriso (`sudo apt-get install xorriso`)
- Optional: qemu or bochs for emulation.

```
git clone --recursive https://github.com/abanu-org/abanu.git
cd abanu
./abctl configure mosa # Build the Mosa-Compiler
./abctl build all # Builds the abanu kernel and creates a disk image
```
Run it with `./abctl run qemu x86` or `./abanuctl run bochs x86`
Visit: [http://docs.abanu.org/en/latest/build.html](http://docs.abanu.org/en/latest/build.html)

## The technology behind this project

Expand All @@ -61,7 +46,7 @@ This is a research project / proof of concept. So it isn't a fully functional OS

## Contributing

Feel free to contact Arakis, open a Issue or a Pull Request.
Feel free to contact us, open a Issue or a Pull Request.

## License
Abanu is published under the GNU General Public License (Version 2, only). This software includes third party open source software components. Each of these software components have their own license. All sourcecode is open source.

0 comments on commit 48b2b54

Please sign in to comment.