From 7951b1eb275343706e6248133340bde329a3a1a7 Mon Sep 17 00:00:00 2001 From: shikhin Date: Mon, 27 Mar 2023 17:10:12 +0530 Subject: [PATCH] Update README. --- README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 65 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e09da08..2f69887 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,71 @@ -TODO ----- -Feel free to add anything you think would fit in +# PonyDOS + +### What is PonyDOS? + +PonyDOS is a hobby 512-byte operating system, designed for ponies like you! + +### Is PonyDOS a DOS distribution? + +No! PonyDOS uses its own 512-byte kernel, built from scratch. + +### Screenshots + +[todo: insert screenshots here] + +### Building from scratch + +To build PonyDOS from scratch, on an environment with `nasm` and `python3`, +run `make`. `make run` runs the floppy disk image `ponydos.img` with QEMU. + +### How do I contribute? + +There is a model `hello.asm` file to demonstrate how best to use the +multitude of features the kernel provides. Build your own program on top– +write an assembler, an audio mixer, a `ponysay`, whatever your heart desires! +–and [todo: ???]. + +### Credits + +This is a parody of [klange](https://github.com/klange)'s wonderful +[PonyOS](https://ponyos.org/). The creators of this project, CrazyEttin, +nortti, and [shikhin](https://shikhin.in) hang out in [todo: redacted]. + +### What are people saying about PonyDOS? + +Nothing so far. + +## FAQ + +#### Does PonyDOS work on real hardware? + +Yes! PonyDOS works on many different machines. The kernel can run on any +80286-compatible CPU, and the applications on any 8086-compatible CPU. + +#### Is this _really_ not a DOS distribution? + +PonyDOS is not a DOS distribution---it's also not a BSD, or a Hurd, or a +Minix, or a [Sortix](https://sortix.org/)! + +#### How do I resize windows? + +If the top-left corner of the window is the ↨ symbol, you can click and drag +the symbol to resize. + +#### I started a window and it doesn't have a title bar, how do I exit it? + +You don't. + +#### How do I install PonyDOS? + +At the moment, PonyOS is only offered as a live flopp disk image with no +installation option, for your safety. + +## TODO ### Basic stuff -* a release-able README +* be able to click on asm/text files in file listing to open +* delete the TODO from release README ### Nice to have