Added readme

This commit is contained in:
2015-01-25 17:53:17 -08:00
parent f6e2d0c19b
commit 977285b8aa
2 changed files with 34 additions and 0 deletions

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
Piquant
====
Piquant is a little toy operating system I'm building.
Why?
=====
Because it's fun. Don't you like to have fun? Ogre.
What does it do?
=====
Right now, not much of anything at all. It boots from a 1.44mB floppy disk, throws some text to the screen, and enters a primitive REPL (where you can do nothing but display a help message, HALT the machine, or RESET the machine).
![Image of Piquant v0.1](media/screenshot.png)
I think I'm going to expand the basic REPL into a BASIC interpreter, just like the classic machines of the 80s. "Operating System? Oh, you mean the BASIC ROM, right?" :)
How can I run it?
=====
You have to build it to run it. To build it, you need:
* bcc (bruce's c compiler - check your OS's package repositories)
* nasm
* gnu make
* ld86, objdump86, as86
To run it, you can use anything, but the makefile assumes you have 'bochs' installed.
make clean test
This will rebuild all of the sources and fire up the bochs emulator. Have fun.

BIN
media/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB