Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
copy committed Aug 31, 2020
1 parent 8d6baff commit fe8d462
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 9 deletions.
33 changes: 24 additions & 9 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,32 @@
[![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)
Building
-

See `docker/test-image/Dockerfile` for a full setup on Debian.

You need:

- java
- gcc, make, libc-i386
- nasm, gdb and qemu (for running tests)
- rust-nightly with the wasm32-unknown-unknown target
- nodejs (a latest version is required, 10.11.0 is known to be working)

Demos
Run `make all-debug` to build the debug build (at `debug.html`).
Run `make all` to build the optimized build (at `index.html`).

Testing
-

- [Windows 98](https://copy.sh/v86/?profile=windows98)
- [Linux](https://copy.sh/v86/?profile=linux26)
- [Linux 3](https://copy.sh/v86/?profile=linux3)
- [KolibriOS](https://copy.sh/v86/?profile=kolibrios)
- [FreeDOS](https://copy.sh/v86/?profile=freedos)
- [Windows 1.01](https://copy.sh/v86/?profile=windows1)
- [Archlinux](https://copy.sh/v86/?profile=archlinux)
Run all tests: `make jshint rustfmt kvm-unit-test nasmtests nasmtests-force-jit expect-tests jitpagingtests qemutests rust-test tests`

Creating a Linux image for use in v86
-

See `docker/debian-full/Readme.md`.


Below is the readme of the open-source version of v86 (not everything applies)
=

API examples
-
Expand Down
9 changes: 9 additions & 0 deletions docker/debian-full/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
You can build a Linux image for use with v86:

1. Run `./build-container.sh` to build the Docker container (requires dockerd)
2. Run `./create-9p-from-container.sh` to extract the files for v86 from the Docker container (requires root)
3. Run `./build-state.js` to build a state image in order to skip the boot process

Go to `debug.html?profile=debian` to start the generated container.

You can modify the `Dockerfile` to customize the generated Linux image.

0 comments on commit fe8d462

Please sign in to comment.