Use markdown for the README file.
authorcoderain <coderain@sdf.org>
Sun, 19 Feb 2017 16:26:55 +0000 (17:26 +0100)
committercoderain <coderain@sdf.org>
Sun, 19 Feb 2017 16:26:55 +0000 (17:26 +0100)
.gitignore
README [deleted file]
README.md [new file with mode: 0644]

index e360b303a37e23adcc8db1a22c179f0d641813e3..9cf9e3cbc410fcd95e786f0a51843bea6c3d7d1e 100644 (file)
@@ -3,7 +3,7 @@
 # Include the following files:
 !.gitignore
 !COPYING
-!README
+!README.md
 !grub.cfg
 !Makefile
 !kernel
diff --git a/README b/README
deleted file mode 100644 (file)
index 7cba412..0000000
--- a/README
+++ /dev/null
@@ -1,42 +0,0 @@
-********************************************************************************
-              __  ___                  ___ __  __    _
-             /  |/  /___  ____  ____  / (_) /_/ /_  (_)_  ______ ___
-            / /|_/ / __ \/ __ \/ __ \/ / / __/ __ \/ / / / / __ `__ \
-           / /  / / /_/ / / / / /_/ / / / /_/ / / / / /_/ / / / / / /
-          /_/  /_/\____/_/ /_/\____/_/_/\__/_/ /_/_/\__,_/_/ /_/ /_/
-
-********************************************************************************
-
-Monolithium is a 32-bit operating system for x86 PCs. It is not a Unix-like
-system, and shares almost nothing with the Unix architecture. Written
-completely from scratch, it is completely incompatible with other operating
-systems. Currently, only the Monolithium kernel is implemented. The other major
-components, the "system library" and "system manager", are still missing.
-
-Monolithium wasn't implemented according to any existing design, it was more or
-less designed as it was implemented, so the current interface may not be
-consistent. During this phase of its development, its kernel module interface
-and application programming interface are not stable and subject to major
-changes.
-
-FREQUENTLY ASKED QUESTIONS
-
-1) Why write another OS from scratch?
-
-Most software development today is focused on assembling software from existing
-"building blocks", using libraries and high-level programming languages, which
-are designed to be complex and generic because they need to cover a lot of use
-cases. Simplicity is a very useful trait that is often overlooked. Monolithium
-is one of the few operating system projects with simplicity as its primary goal.
-
-2) Why is there no development history?
-
-I started this project in 2011, before I understood how VCS systems work and why
-they're important. I made backups at regular intervals, but since I didn't use
-git, there are no commits before the first release.
-
-3) Will the interface ever become stable?
-
-Having a stable interface, which will not change to the extent that later
-versions break software running in userspace, is one of the end goals of
-the project.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..a47cc6e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+<pre>
+********************************************************************************
+              __  ___                  ___ __  __    _
+             /  |/  /___  ____  ____  / (_) /_/ /_  (_)_  ______ ___
+            / /|_/ / __ \/ __ \/ __ \/ / / __/ __ \/ / / / / __ `__ \
+           / /  / / /_/ / / / / /_/ / / / /_/ / / / / /_/ / / / / / /
+          /_/  /_/\____/_/ /_/\____/_/_/\__/_/ /_/_/\__,_/_/ /_/ /_/
+
+********************************************************************************
+</pre>
+
+### What is Monolithium? ###
+
+Monolithium is a 32-bit operating system for x86 PCs. It is not a Unix-like
+system, and shares almost nothing with the Unix architecture. Written
+completely from scratch, it is completely incompatible with other operating
+systems. Currently, only the Monolithium kernel is implemented. The other major
+components, the "system library" and "system manager", are still missing.
+
+Monolithium wasn't implemented according to any existing design, it was more or
+less designed as it was implemented, so the current interface may not be
+consistent. During this phase of its development, its kernel module interface
+and application programming interface are not stable and subject to major
+changes.
+
+### FREQUENTLY ASKED QUESTIONS ###
+
+**1) Why write another OS from scratch?**
+
+Most software development today is focused on assembling software from existing
+"building blocks", using libraries and high-level programming languages, which
+are designed to be complex and generic because they need to cover a lot of use
+cases. Simplicity is a very useful trait that is often overlooked. Monolithium
+is one of the few operating system projects with simplicity as its primary goal.
+
+**2) Why is there no development history?**
+
+I started this project in 2011, before I understood how VCS systems work and why
+they're important. I made backups at regular intervals, but since I didn't use
+git, there are no commits before the first release.
+
+**3) Will the interface ever become stable?**
+
+Having a stable interface, which will not change to the extent that later
+versions break software running in userspace, is one of the end goals of
+the project.