os-k/README.md

# OS/K (OS on Kaleid) 

| ![FSF Logo](https://www.os-k.eu/GPLLOGO.png) | This program is free software, released under the terms of the [GNU GPL](COPYING) version 3 or later as published by the Free Software Foundation |
|----------------------------------------------|----------------------------------------------------------------------|

### Fully free operating system from scratch (WIP)

For the project plan, see [OS/K Project](https://github.com/orgs/os-k-team/projects/1)

For changelog, see [ChangeLog](ChangeLog)

For structure of the sources, see [ProjectTree](ProjectTree)

For our IRC channel, see `#os.k-devel` on [Freenode](https://webchat.freenode.net)

Note that every file within OS/K is written using spaces for tabulation, with each
tabulation being 4 spaces long.

#### Compile from sources

To compile this project from sources, you must first install the dependencies

```
apt update && apt upgrade
apt install grub-pc-bin dosfstools make nasm qemu tree libisl15 parted udisks2
```

You also need to have the [x86-64 ELF gcc cross-compiler](https://www.os-k.eu/build-tools/cross-cc.tar.xz) and its ``bin`` directory in your PATH.

To compile, simply use at the root of this project : 
```
make
```

To compile and test, simply use at the root of this project :
```
make test
```

To compile and install, simply use at the root of this project, with XXX the image or block file you want to use :
```
make install installdisk=XXX
```

#### Screenshot
![OS/K Started](https://www.os-k.eu/images/screen6.png)