collapseos/doc/README.md

# Collapse OS documentation

## Assembly guide

* [Writing the glue code](glue-code.md)
* [Running Collapse OS on an emulator](emulate.md)

## User guide

* [The shell](../apps/shell/README.md)
* [Load code in RAM and run it](load-run-code.md)
* [Using block devices](blockdev.md)
* [Using the filesystem](fs.md)
* [Assembling z80 source from the shell](zasm.md)
doc: add glue code section 2019-04-17 01:25:54 +10:00			`# Collapse OS documentation`
Add user guide 2019-04-16 02:06:27 +10:00
doc: add glue code section 2019-04-17 01:25:54 +10:00			`## Assembly guide`
Add user guide 2019-04-16 02:06:27 +10:00
doc: add glue code section 2019-04-17 01:25:54 +10:00			`* [Writing the glue code](glue-code.md)`
Add filesystem docs 2019-05-13 06:06:27 +10:00			`* [Running Collapse OS on an emulator](emulate.md)`
doc: add glue code section 2019-04-17 01:25:54 +10:00
			`## User guide`
Add user guide 2019-04-16 02:06:27 +10: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-16 07:37:49 +11:00			`* [The shell](../apps/shell/README.md)`
Improve user guide 2019-04-16 03:18:29 +10:00			`* [Load code in RAM and run it](load-run-code.md)`
Add blockdev doc 2019-04-17 00:37:29 +10:00			`* [Using block devices](blockdev.md)`
Add filesystem docs 2019-05-13 06:06:27 +10:00			`* [Using the filesystem](fs.md)`
We can now assemble source files from within the shell! 2019-06-04 01:15:07 +10:00			`* [Assembling z80 source from the shell](zasm.md)`