Reword readme

This commit is contained in:
copy 2015-09-15 07:25:20 +02:00
parent f59c5e3228
commit e2eeb295f2

View file

@ -1,7 +1,7 @@
[![Join the chat at https://gitter.im/copy/v86](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/copy/v86?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Demos
Demos
-
- [Linux](http://copy.sh/v86/?profile=linux26)
@ -70,11 +70,20 @@ v86 emulates an x86-compatible CPU and hardware. Here's a list of emulated hardw
- A virtio filesystem.
Testing
-
The disk images are not included in this repository. You can download them
directly from the website using:
`wget -P images/ http://copy.sh/v86/images/{linux.iso,linux3.iso,kolibri.img,windows101.img,os8.dsk,freedos722.img,openbsd.img}`.
A testsuite is available in `tests/full/`. Run it using `node tests/full/run.js`.
How to build, run and embed?
-
- In order to build the `cpu.js` file, you need `make` and `cpp` (the C preprocessor).
Run: `make build/cpu.js`.
- If you want a compressed and fast (i.e. with debug code removed) version, you
need Closure Compiler. Download it as shown below and run `make build/v86_all.js`.
- ROM and disk images are loaded via XHR, so if you want to try out `index.html`
@ -86,7 +95,7 @@ How to build, run and embed?
using `wget -P images/ http://copy.sh/v86/images/{linux.iso,linux3.iso,kolibri.img,windows101.img,os8.dsk,freedos722.img,openbsd.img}`.
**Summary:**
**Short summary:**
```bash
# grab the main repo
@ -100,23 +109,16 @@ wget -P images/ http://copy.sh/v86/images/{linux.iso,linux3.iso,kolibri.img,wind
# grab closure compiler
wget -P closure-compiler http://dl.google.com/closure-compiler/compiler-latest.zip
unzip -d closure-compiler closure-compiler/compiler-latest.zip compiler.jar
# build the library
make build/lib86.js
# run the tests
./tests/full/run.js
```
Rebuild compiled version:
```
make
```
Rebuild only debug version (only necessary after changing `.macro.js` files):
```
make build/cpu.js
```
Why?
-
Why?
-
Similiar projects have been done before, but I decided to work on this as a fun
project and learn something about the x86 architecture. It has grown pretty
@ -139,7 +141,7 @@ Here's an overview of the operating systems supported in v86:
terminal.
- Nanolinux works.
- Archlinux works. Add `atkbd` to `MODULES` in `/etc/mkinitcpio.conf`.
- FreeDOS and Windows 1.01 run very well.
- FreeDOS and Windows 1.01 run very well.
- KolibriOS works. A few applications need SSE.
- Haiku boots, but takes very long (around 30 minutes). Set the memory size to 128MB.
- ReactOS doesn't work.
@ -165,7 +167,7 @@ Simplified BSD License, see [LICENSE](LICENSE), unless otherwise noted.
Credits
-
- Test cases via QEMU, http://wiki.qemu.org/Main_Page
- Test cases via QEMU, http://wiki.qemu.org/Main_Page
- [Disk Images](https://github.com/copy/images)
- [The jor1k project](https://github.com/s-macke/jor1k) for 9p and filesystem drivers