collapseos/kernel/README.md

# Kernel

Bits and pieces of code that you can assemble to build a kernel for your
machine.

These parts are made to be glued together in a single `glue.asm` file you write
yourself.

This code is designed to be assembled by Collapse OS' own [zasm][zasm].

## Scope

Units in the `kernel/` folder is about device driver, abstractions over them
as well as the file system. Although a typical kernel boots to a shell, the
code for that shell is not considered part of the kernel code (even if, most of
the time, it's assembled in the same binary). Shells are considered userspace
applications (which live in `apps/`).
Move /parts/z80 to /kernel Let go of that "meta os" thing. it's not as meta as I made it sound like. It's a kernel. 2019-05-19 11:19:41 -04:00			`# Kernel`
Split parts in two: z80 and avr Also, clarify the role of recipes. 2019-04-25 16:03:45 -04:00
Move /parts/z80 to /kernel Let go of that "meta os" thing. it's not as meta as I made it sound like. It's a kernel. 2019-05-19 11:19:41 -04:00			`Bits and pieces of code that you can assemble to build a kernel for your`
			`machine.`
Split parts in two: z80 and avr Also, clarify the role of recipes. 2019-04-25 16:03:45 -04:00
Move /parts/z80 to /kernel Let go of that "meta os" thing. it's not as meta as I made it sound like. It's a kernel. 2019-05-19 11:19:41 -04:00			These parts are made to be glued together in a single `glue.asm` file you write
Split parts in two: z80 and avr Also, clarify the role of recipes. 2019-04-25 16:03:45 -04:00			`yourself.`

Update docs w.r.t. its relationship with scas 2019-06-19 13:34:06 -04:00			`This code is designed to be assembled by Collapse OS' own [zasm][zasm].`
Split parts in two: z80 and avr Also, clarify the role of recipes. 2019-04-25 16:03:45 -04:00
Make the shell a userspace app That's my mega-commit you've all been waiting for. The code for the shell share more routines with userspace apps than with kernel units, because, well, its behavior is that of a userspace app, not a device driver. This created a weird situation with libraries and jump tables. Some routine belonging to the `kernel/` directory felt weird there. And then comes `apps/basic`, which will likely share even more code with the shell. I was seeing myself creating huge jump tables to reuse code from the shell. It didn't feel right. Moreover, we'll probably want basic-like apps to optionnally replace the shell. So here I am with this huge change in the project structure. I didn't test all recipes on hardware yet, I will do later. I might have broken some... But now, the structure feels better and the line between what belongs to `kernel` and what belongs to `apps` feels clearer. 2019-11-15 15:37:49 -05:00			`## Scope`
Split parts in two: z80 and avr Also, clarify the role of recipes. 2019-04-25 16:03:45 -04:00
Make the shell a userspace app That's my mega-commit you've all been waiting for. The code for the shell share more routines with userspace apps than with kernel units, because, well, its behavior is that of a userspace app, not a device driver. This created a weird situation with libraries and jump tables. Some routine belonging to the `kernel/` directory felt weird there. And then comes `apps/basic`, which will likely share even more code with the shell. I was seeing myself creating huge jump tables to reuse code from the shell. It didn't feel right. Moreover, we'll probably want basic-like apps to optionnally replace the shell. So here I am with this huge change in the project structure. I didn't test all recipes on hardware yet, I will do later. I might have broken some... But now, the structure feels better and the line between what belongs to `kernel` and what belongs to `apps` feels clearer. 2019-11-15 15:37:49 -05:00			Units in the `kernel/` folder is about device driver, abstractions over them
			`as well as the file system. Although a typical kernel boots to a shell, the`
			`code for that shell is not considered part of the kernel code (even if, most of`
			`the time, it's assembled in the same binary). Shells are considered userspace`
			applications (which live in `apps/`).