Go to file
Hennik Hunsaker 7d932d43b3 Add Pandoc Support
- Add a Pandoc defaults file
- Add a Pandoc template based on the default one
- Add chapter headers to each section

### Usage

To use, install Pandoc and ConTeXt, then simply run
`pandoc -d ./pandoc.yaml` from the repo root.

### Maintenance

When new chapters get added, the `pandoc.yaml` will need to be updated
to include each new chapter's markdown file(s).

### Miscellaneous Notes

- The PDF generated complies with PDF/A 1b:2005 by default.
- The PDF also contains the source markdown files as attachments
- All links are fully functional!
- Includes a table of contents! With links to each section!

### Conclusion

Enjoy!
2023-09-05 01:46:32 -06:00
00-environment Add Pandoc Support 2023-09-05 01:46:32 -06:00
01-bootsector-barebones Add Pandoc Support 2023-09-05 01:46:32 -06:00
02-bootsector-print Add Pandoc Support 2023-09-05 01:46:32 -06:00
03-bootsector-memory Add Pandoc Support 2023-09-05 01:46:32 -06:00
04-bootsector-stack Add Pandoc Support 2023-09-05 01:46:32 -06:00
05-bootsector-functions-strings Add Pandoc Support 2023-09-05 01:46:32 -06:00
06-bootsector-segmentation Add Pandoc Support 2023-09-05 01:46:32 -06:00
07-bootsector-disk Add Pandoc Support 2023-09-05 01:46:32 -06:00
08-32bit-print Add Pandoc Support 2023-09-05 01:46:32 -06:00
09-32bit-gdt Add Pandoc Support 2023-09-05 01:46:32 -06:00
10-32bit-enter Add Pandoc Support 2023-09-05 01:46:32 -06:00
11-kernel-crosscompiler Add Pandoc Support 2023-09-05 01:46:32 -06:00
12-kernel-c Add Pandoc Support 2023-09-05 01:46:32 -06:00
13-kernel-barebones Add Pandoc Support 2023-09-05 01:46:32 -06:00
14-checkpoint Add Pandoc Support 2023-09-05 01:46:32 -06:00
15-video-ports Add Pandoc Support 2023-09-05 01:46:32 -06:00
16-video-driver Add Pandoc Support 2023-09-05 01:46:32 -06:00
17-video-scroll Add Pandoc Support 2023-09-05 01:46:32 -06:00
18-interrupts Add Pandoc Support 2023-09-05 01:46:32 -06:00
19-interrupts-irqs Add Pandoc Support 2023-09-05 01:46:32 -06:00
20-interrupts-timer Add Pandoc Support 2023-09-05 01:46:32 -06:00
21-shell Add Pandoc Support 2023-09-05 01:46:32 -06:00
22-malloc Add Pandoc Support 2023-09-05 01:46:32 -06:00
23-fixes Add Pandoc Support 2023-09-05 01:46:32 -06:00
24-el-capitan Add Pandoc Support 2023-09-05 01:46:32 -06:00
.gitignore Add Pandoc Support 2023-09-05 01:46:32 -06:00
LICENSE Create license. Closes #51 2018-09-22 11:31:27 +02:00
pandoc.context Add Pandoc Support 2023-09-05 01:46:32 -06:00
pandoc.yaml Add Pandoc Support 2023-09-05 01:46:32 -06:00
README.md Update README.md 2018-04-19 10:05:19 +02:00

os-tutorial

How to create an OS from scratch!

I have always wanted to learn how to make an OS from scratch. In college I was taught how to implement advanced features (pagination, semaphores, memory management, etc) but:

  • I never got to start from my own boot sector
  • College is hard so I don't remember most of it.
  • I'm fed up with people who think that reading an already existing kernel, even if small, is a good idea to learn operating systems.

Inspired by this document and the OSDev wiki, I'll try to make short step-by-step READMEs and code samples for anybody to follow. Honestly, this tutorial is basically the first document but split into smaller pieces and without the theory.

Updated: more sources: the little book about OS development, JamesM's kernel development tutorials

Features

  • This course is a code tutorial aimed at people who are comfortable with low level computing. For example, programmers who have curiosity on how an OS works but don't have the time or willpower to start reading the Linux kernel top to bottom.
  • There is little theory. Yes, this is a feature. Google is your theory lecturer. Once you pass college, excessive theory is worse than no theory because it makes things seem more difficult than they really are.
  • The lessons are tiny and may take 5-15 minutes to complete. Trust me and trust yourself. You can do it!

How to use this tutorial

  1. Start with the first folder and go down in order. They build on previous code, so if you jump right to folder 05 and don't know why there is a mov ah, 0x0e, it's because you missed lecture 02. Really, just go in order. You can always skip stuff you already know.

  2. Open the README and read the first line, which details the concepts you should be familiar with before reading the code. Google concepts you are not familiar with. The second line states the goals for each lesson. Read them, because they explain why we do what we do. The "why" is as important as the "how".

  3. Read the rest of the README. It is very concise.

  4. (Optional) Try to write the code files by yourself after reading the README.

  5. Look at the code examples. They are extremely well commented.

  6. (Optional) Experiment with them and try to break things. The only way to make sure you understood something is trying to break it or replicate it with different commands.

TL;DR: First read the README on each folder, then the code files. If you're brave, try to code them yourself.

Strategy

We will want to do many things with our OS:

  • Boot from scratch, without GRUB - DONE!
  • Enter 32-bit mode - DONE
  • Jump from Assembly to C - DONE!
  • Interrupt handling - DONE!
  • Screen output and keyboard input - DONE!
  • A tiny, basic libc which grows to suit our needs - DONE!
  • Memory management
  • Write a filesystem to store files
  • Create a very simple shell
  • User mode
  • Maybe we will write a simple text editor
  • Multiple processes and scheduling

Probably we will go through them in that order, however it's soon to tell.

If we feel brave enough:

  • A BASIC interpreter, like in the 70s!
  • A GUI
  • Networking

Contributing

This is a personal learning project, and even though it hasn't been updated for a long time, I still have hopes to get into it at some point.

I'm thankful to all those who have pointed out bugs and submitted pull requests. I will need some time to review everything and I cannot guarantee that at this moment.

Please feel free to fork this repo. If many of you are interested in continuing the project, let me know and I'll link the "main fork" from here.