Browse Source

Use markdown for the README file.

coderain 7 years ago
parent
commit
1a0bfe9f04
2 changed files with 9 additions and 5 deletions
  1. 1 1
      .gitignore
  2. 8 4
      README.md

+ 1 - 1
.gitignore

@@ -3,7 +3,7 @@
 # Include the following files:
 !.gitignore
 !COPYING
-!README
+!README.md
 !grub.cfg
 !Makefile
 !kernel

+ 8 - 4
README → README.md

@@ -1,3 +1,4 @@
+<pre>
 ********************************************************************************
               __  ___                  ___ __  __    _
              /  |/  /___  ____  ____  / (_) /_/ /_  (_)_  ______ ___
@@ -6,6 +7,9 @@
           /_/  /_/\____/_/ /_/\____/_/_/\__/_/ /_/_/\__,_/_/ /_/ /_/
 
 ********************************************************************************
+</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
@@ -19,9 +23,9 @@ 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
+### FREQUENTLY ASKED QUESTIONS ###
 
-1) Why write another OS from scratch?
+**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
@@ -29,13 +33,13 @@ 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?
+**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?
+**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