Luna/README.md

# Luna
A simple POSIX-based operating system for personal computers, written in C++. [![Build Status](https://drone.cloudapio.eu/api/badges/apio/Luna/status.svg)](https://drone.cloudapio.eu/apio/Luna)

## Another UNIX clone?
[Yes, another UNIX clone](https://wiki.osdev.org/User:Sortie/Yes_Another_Unix_Clone).

## Features
- x86_64-compatible lightweight [kernel](kernel/).
- Simple round-robin [scheduler](kernel/src/thread/).
- Read-only [ext2](kernel/src/fs/ext2/) filesystem.
- Can [load ELF programs](kernel/src/binfmt/ELF.cpp), [shebang scripts](kernel/src/binfmt/Script.cpp) or [arbitrary binary formats](kernel/src/binfmt/BinaryFormat.h) (registered through kernel modules, which are not supported yet =D).
- [C Library](libc/), aiming for POSIX compatibility, with many features such as local domain sockets, signals, and shared memory.
- Support for [several third-party programs](ports/), including the [GNU binutils](ports/binutils/PACKAGE) suite of utilities.
- Designed to be [portable](kernel/src/arch), no need to be restricted to x86_64.
- Everything is designed around [UTF-8](libluna/include/luna/Utf8.h).
- Environment-agnostic [utility library](libluna/), which can be used in both kernel and userspace.
- An extensive set of [standard Unix utilities](apps/), from [ls](apps/ls.cpp) to [uname](apps/uname.cpp) to [base64](apps/base64.cpp). Written in modern C++ and very small amounts of code, using Luna's practical [OS library](libos/).
- A simple and efficient [windowing system](wind/), providing a lightweight GUI environment (still in development, not many GUI apps exist).

## Screenshot
![Screenshot as of 0.6.0](docs/screenshots/screenshot-0.6.0.png)

## Setup

To build and run Luna, you will need to build a [cross-compiler](https://wiki.osdev.org/Why_do_I_need_a_Cross_Compiler) and cross-binutils for `x86_64-luna`.

For this, you should start by installing the [required dependencies](https://wiki.osdev.org/GCC_Cross_Compiler#Installing_Dependencies).

Then, run `tools/setup.sh` to build the toolchain.

Please beware that building GCC and Binutils can take some time, depending on your machine.

## Running

To run Luna in a virtual machine, you should have [QEMU](https://www.qemu.org/) installed.

Additionally, the build process needs some extra dependencies to run: `cmake`, `ninja`, `nasm`, `fakeroot` and `genext2fs`.

`tools/run.sh` is the script you should use in most cases. It will build changed files, install, make an ISO image, and run Luna in QEMU.

If you have no toolchain set up, `run.sh` will build it automatically, which means that you don't necessarily have to run `setup.sh` manually since `run.sh` does it for you.

## Prebuilt images

Prebuilt ISO images for every release version can be found at [pub.cloudapio.eu](https://pub.cloudapio.eu/luna/releases).

## Is there third-party software I can use on Luna?

Yes! A ports system is in place, and you can use the build scripts to add some ports to your image. More information in the [Ports](ports/README.md) page.

## License
Luna is open-source and free software under the [BSD-2-Clause License](LICENSE).
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00			`# Luna`
Update README.md 2023-08-08 14:04:10 +00:00			`A simple POSIX-based operating system for personal computers, written in C++. [![Build Status](https://drone.cloudapio.eu/api/badges/apio/Luna/status.svg)](https://drone.cloudapio.eu/apio/Luna)`
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00
Add clause about Unix to README.md 2023-04-04 20:57:55 +00:00			`## Another UNIX clone?`
			`[Yes, another UNIX clone](https://wiki.osdev.org/User:Sortie/Yes_Another_Unix_Clone).`

Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00			`## Features`
Rewrite README.md now that restart is gone 2023-01-08 14:55:01 +00:00			`- x86_64-compatible lightweight [kernel](kernel/).`
Update README.md 2023-09-20 19:07:37 +00:00			`- Simple round-robin [scheduler](kernel/src/thread/).`
			`- Read-only [ext2](kernel/src/fs/ext2/) filesystem.`
README: More features 2023-08-08 14:19:38 +00:00			`- Can [load ELF programs](kernel/src/binfmt/ELF.cpp), [shebang scripts](kernel/src/binfmt/Script.cpp) or [arbitrary binary formats](kernel/src/binfmt/BinaryFormat.h) (registered through kernel modules, which are not supported yet =D).`
Update README.md 2023-09-20 19:07:37 +00:00			`- [C Library](libc/), aiming for POSIX compatibility, with many features such as local domain sockets, signals, and shared memory.`
README: More features 2023-08-08 14:19:38 +00:00			`- Support for [several third-party programs](ports/), including the [GNU binutils](ports/binutils/PACKAGE) suite of utilities.`
Rewrite README.md now that restart is gone 2023-01-08 14:55:01 +00:00			`- Designed to be [portable](kernel/src/arch), no need to be restricted to x86_64.`
Update README.md 2023-09-20 19:07:37 +00:00			`- Everything is designed around [UTF-8](libluna/include/luna/Utf8.h).`
README: Update luna/ links to point to libluna/ 2023-03-11 09:37:38 +00:00			`- Environment-agnostic [utility library](libluna/), which can be used in both kernel and userspace.`
README: More features 2023-08-08 14:19:38 +00:00			`- An extensive set of [standard Unix utilities](apps/), from [ls](apps/ls.cpp) to [uname](apps/uname.cpp) to [base64](apps/base64.cpp). Written in modern C++ and very small amounts of code, using Luna's practical [OS library](libos/).`
Update README.md 2023-09-20 19:07:37 +00:00			`- A simple and efficient [windowing system](wind/), providing a lightweight GUI environment (still in development, not many GUI apps exist).`

			`## Screenshot`
			`![Screenshot as of 0.6.0](docs/screenshots/screenshot-0.6.0.png)`
Update README.md 2022-10-29 08:13:36 +00:00
Rewrite README.md now that restart is gone 2023-01-08 14:55:01 +00:00			`## Setup`
Update README.md 2022-12-07 10:13:16 +00:00
Update README.md 2023-07-22 09:45:35 +00:00			To build and run Luna, you will need to build a [cross-compiler](https://wiki.osdev.org/Why_do_I_need_a_Cross_Compiler) and cross-binutils for `x86_64-luna`.
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00
Update README.md 2023-07-22 09:45:35 +00:00			`For this, you should start by installing the [required dependencies](https://wiki.osdev.org/GCC_Cross_Compiler#Installing_Dependencies).`
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00
Update README.md 2023-07-11 09:50:57 +00:00			Then, run `tools/setup.sh` to build the toolchain.
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00
			`Please beware that building GCC and Binutils can take some time, depending on your machine.`

			`## Running`

Update README.md 2023-07-22 09:45:35 +00:00			`To run Luna in a virtual machine, you should have [QEMU](https://www.qemu.org/) installed.`

Add fakeroot dependency 2024-02-10 10:50:01 +00:00			Additionally, the build process needs some extra dependencies to run: `cmake`, `ninja`, `nasm`, `fakeroot` and `genext2fs`.
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00
Update README.md 2023-07-11 09:50:57 +00:00			`tools/run.sh` is the script you should use in most cases. It will build changed files, install, make an ISO image, and run Luna in QEMU.
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00
Update README.md 2024-03-28 21:37:16 +00:00			If you have no toolchain set up, `run.sh` will build it automatically, which means that you don't necessarily have to run `setup.sh` manually since `run.sh` does it for you.
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00
			`## Prebuilt images`

Update README.md 2024-03-28 21:37:16 +00:00			`Prebuilt ISO images for every release version can be found at [pub.cloudapio.eu](https://pub.cloudapio.eu/luna/releases).`
Update README.md with information about hourly builds 2022-10-24 19:12:22 +00:00
600th commit! 1. Update the bc patch to remove an unnecessary line. 2. Update README.md to mention the port system. 3. Improve the port system!! 2022-10-23 15:15:38 +00:00			`## Is there third-party software I can use on Luna?`

ports: Add initial documentation to the port system 2023-07-24 16:29:44 +00:00			`Yes! A ports system is in place, and you can use the build scripts to add some ports to your image. More information in the [Ports](ports/README.md) page.`
600th commit! 1. Update the bc patch to remove an unnecessary line. 2. Update README.md to mention the port system. 3. Improve the port system!! 2022-10-23 15:15:38 +00:00
Finally, add a README. It's perhaps too long, but that's better than it being too short. 2022-10-07 18:16:44 +00:00			`## License`
Update README.md 2023-07-30 09:55:08 +00:00			`Luna is open-source and free software under the [BSD-2-Clause License](LICENSE).`