From e5a1520db4ae947a9d9b7b629660eb0576fbc084 Mon Sep 17 00:00:00 2001
From: Able <abl3theabove@gmail.com>
Date: Sun, 7 May 2023 18:48:45 -0500
Subject: [PATCH] init

---
 README.md          | 11 +++++++++++
 REQUIREMENTS.md    | 28 ++++++++++++++++++++++++++++
 build.sh           |  0
 choices.md         | 12 ++++++++++++
 journal_example.md |  3 +++
 run.sh             | 10 ++++++++++
 6 files changed, 64 insertions(+)
 create mode 100644 README.md
 create mode 100644 REQUIREMENTS.md
 create mode 100755 build.sh
 create mode 100644 choices.md
 create mode 100644 journal_example.md
 create mode 100755 run.sh

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f5b703
--- /dev/null
+++ b/README.md
@@ -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
\ No newline at end of file
diff --git a/REQUIREMENTS.md b/REQUIREMENTS.md
new file mode 100644
index 0000000..b12b318
--- /dev/null
+++ b/REQUIREMENTS.md
@@ -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()
+
diff --git a/build.sh b/build.sh
new file mode 100755
index 0000000..e69de29
diff --git a/choices.md b/choices.md
new file mode 100644
index 0000000..aa7b9c6
--- /dev/null
+++ b/choices.md
@@ -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
diff --git a/journal_example.md b/journal_example.md
new file mode 100644
index 0000000..7d692b4
--- /dev/null
+++ b/journal_example.md
@@ -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
\ No newline at end of file
diff --git a/run.sh b/run.sh
new file mode 100755
index 0000000..945522c
--- /dev/null
+++ b/run.sh
@@ -0,0 +1,10 @@
+
+
+
+
+qemu-system-x86_64 \
+-m 512m \
+-cpu qemu64 \
+-hda disk.img \
+-soundhw ac97 \
+-vga cirrus # Cirrus Logic GD5446 Video card
\ No newline at end of file