init
This commit is contained in:
commit
e5a1520db4
11
README.md
Normal file
11
README.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
# {OS_NAME}
|
||||
Describe your os in a few sentances
|
||||
|
||||
## Usage
|
||||
To keep the overhead of building and running to a minimum we will use these
|
||||
|
||||
### Build
|
||||
`./build.sh` Use this command to build a disk image for use with qemu
|
||||
|
||||
### Run
|
||||
`./run.sh` Use this after building the kernel
|
28
REQUIREMENTS.md
Normal file
28
REQUIREMENTS.md
Normal file
|
@ -0,0 +1,28 @@
|
|||
Anti requirements
|
||||
Bootloader
|
||||
use something like grub
|
||||
Points should be deducted for external libraries (case by case basis)
|
||||
|
||||
|
||||
REQUIREMENTS
|
||||
A little micro journal of what was implemented and why
|
||||
|
||||
|
||||
Some format of documentation for the system
|
||||
Bonus points for making the documentation avalible from the system
|
||||
Bonus points for style
|
||||
read and write programs to a disk or have some form of save data
|
||||
|
||||
supported devices
|
||||
keyboard
|
||||
serial
|
||||
timer
|
||||
vga graphics(maybe)
|
||||
|
||||
has programing language with
|
||||
variables
|
||||
control flow
|
||||
math
|
||||
some way to interact with supported devices
|
||||
for example set_pixel()
|
||||
|
12
choices.md
Normal file
12
choices.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
# Implementation language
|
||||
I recommend one of the following and if you use some other language you can expect less well put together support
|
||||
- C
|
||||
- C/C++
|
||||
- C#
|
||||
- Go
|
||||
- Rust
|
||||
|
||||
# Documentation format
|
||||
The documentation for your system and programming language must be in a consistent format
|
||||
Bonus points for making the documentation avalible from the system
|
||||
Bonus points for style
|
3
journal_example.md
Normal file
3
journal_example.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
Day 1 added a file system to save file
|
||||
Day 2 changed file system api because of a bug
|
||||
Day 3 No Progress
|
Loading…
Reference in a new issue