ponydos/README.md

82 lines
2.2 KiB
Markdown
Raw Normal View History

2023-03-27 11:40:12 +00:00
# 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.
By default, `qemu-system-i386` is invoked. If you want to use a different
backend, use `make QEMU=<backend> run`.
2023-03-27 11:40:12 +00:00
### How do I contribute?
There is a model `hello.asm` file to demonstrate how best to use the
2023-03-27 11:50:23 +00:00
multitude of features the kernel provides. Build your own program on topwrite
an assembler, an audio mixer, a `ponysay`, whatever your heart desires!and
contact us to merge it in.
2023-03-27 11:40:12 +00:00
### Credits
This is a parody of [klange](https://github.com/klange)'s wonderful
2023-03-27 15:13:40 +00:00
[PonyOS](https://ponyos.org/). The creators of this project,
[CrazyEttin](https://ahti.space/~crazyettin/),
2023-03-27 11:55:30 +00:00
[nortti](https://ahti.space/~nortti), and [shikhin](https://shikhin.in) hang out
in `#offtopia` on [libera.chat](https://libera.chat/).
2023-03-27 11:40:12 +00:00
### 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?
2023-03-27 12:25:09 +00:00
PonyDOS is not a DOS distributionit's also not a BSD, or a Hurd, or a
2023-03-27 11:40:12 +00:00
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.
2023-03-27 12:25:09 +00:00
#### How do I adjust the mouse sensitivity?
Tweak `X_SENSITIVITY` and `Y_SENSITIVITY` in `ponydos.asm`. Lower values mean
higher sensitivity.
2023-03-27 12:25:09 +00:00
2023-03-27 11:56:57 +00:00
#### I started an application and it doesn't have a title bar, how do I exit it?
2023-03-27 11:40:12 +00:00
You don't.
#### How do I install PonyDOS?
2023-03-27 11:56:57 +00:00
At the moment, PonyOS is only offered as a live floppy disk image with no
2023-03-27 11:40:12 +00:00
installation option, for your safety.
## TODO
2022-02-11 16:16:49 +00:00
### Basic stuff
2023-03-27 11:40:12 +00:00
* be able to click on asm/text files in file listing to open
* delete the TODO from release README
2022-02-11 16:16:49 +00:00
### Nice to have
2023-03-19 15:01:17 +00:00
* ponysay