os-k/README.md

45 lines
1.4 KiB
Markdown
Raw Normal View History

2019-04-03 14:16:04 +02:00
# OS/K (OS on Kaleid)
2019-12-11 22:35:37 +01:00
| ![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 |
2019-04-03 14:16:04 +02:00
|----------------------------------------------|----------------------------------------------------------------------|
### 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)
2019-04-09 15:04:21 +02:00
For our IRC channel, see `#os.k-devel` on [Freenode](https://webchat.freenode.net)
2019-04-09 15:01:33 +02:00
2019-04-03 14:16:04 +02:00
Note that every file within OS/K is written using spaces for tabulation, with each
2019-04-04 18:47:30 +02:00
tabulation being 4 spaces long.
2019-04-03 14:16:04 +02:00
#### Compile from sources
To compile this project from sources, you must first install the dependencies
```
apt update && apt upgrade
2019-06-02 12:04:28 +02:00
apt install grub-pc-bin dosfstools make nasm qemu tree libisl15
2019-04-03 14:16:04 +02:00
```
2019-04-09 15:04:21 +02:00
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.
2019-04-03 14:16:04 +02:00
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
```
2019-04-04 18:47:30 +02:00
2019-11-11 18:49:10 +01:00
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
```