os-k/Readme.md

37 lines
1.1 KiB
Markdown
Raw Normal View History

2019-03-29 20:38:32 +01:00
# OS/K (OS on Kaleid)
2018-12-23 00:02:20 +01:00
2019-02-06 21:51:00 +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-02-06 21:47:59 +01:00
|----------------------------------------------|----------------------------------------------------------------------|
2019-02-06 21:52:46 +01:00
### Fully free operating system from scratch (WIP)
2019-01-14 23:22:51 +01:00
2019-01-14 20:33:38 +01:00
For the project plan, see [OS/K Project](https://github.com/orgs/os-k-team/projects/1)
2018-12-23 20:45:23 +01:00
2019-02-06 21:51:00 +01:00
For changelog, see [ChangeLog](ChangeLog)
2018-12-23 20:45:23 +01:00
2019-02-06 21:51:00 +01:00
For structure of the sources, see [ProjectTree](ProjectTree)
2018-12-23 20:45:23 +01:00
2019-01-14 14:31:49 +01:00
Note that every file within OS/K is written using spaces for tabulation, with each
2019-02-06 21:44:57 +01:00
tabulation being 4 spaces long.
2019-03-09 22:22:57 +01:00
#### Compile from sources
To compile this project from sources, you must first install the dependencies
```
apt update && apt upgrade
2019-03-17 22:52:34 +01:00
apt install grub-pc dosfstools make nasm qemu
2019-03-09 22:22:57 +01:00
```
2019-03-11 13:28:01 +01:00
You also need to have the [x86-64 ELF gcc cross-compiler](https://www.os-k.eu/build-tools/cross-cc.tar.xz) in `/opt/cross-cc`.
2019-03-09 22:22:57 +01:00
2019-03-17 22:52:34 +01:00
To compile, simply use at the root of this project :
2019-03-09 22:22:57 +01:00
```
2019-03-17 22:52:34 +01:00
make
2019-03-09 22:22:57 +01:00
```
2019-03-17 22:52:34 +01:00
To compile and test, simply use at the root of this project :
2019-03-09 22:22:57 +01:00
```
2019-03-17 22:52:34 +01:00
make test
2019-03-09 22:22:57 +01:00
```