docs: Update the docs

This commit is contained in:
Felix Rieseberg 2019-08-24 17:03:56 +02:00
parent 186a2a8ba9
commit 658fed75da
3 changed files with 14 additions and 10 deletions

11
HELP.md
View File

@ -8,20 +8,19 @@ back to a window mode. (Thanks to @DisplacedGamer for that wisdom)
## Windows 95 is stuck in a bad state
Restart the application and click on the "Reset machine & delete state" button.
You can find it in the lower left of the screen. Then, hit the "Start Windows 95"
button to start your virtual machine again.
On the app's home screen, select "Settings" in the lower menu. Then, delete your
machine's state before starting it again - this time hopefully without issues.
## I want to install additional apps or games
If you are running macOS, or Linux, you can probably "mount" the
virtual hard drive used by `windows95` to add files. Hit the "Show Disk Image"
button in the lower right of the app, which will take you to the disk image.
virtual hard drive used by `windows95` to add files. Hit the "Modify C: Drive"
button, which will take you to the disk image.
On macOS, double-click the disk image to open it.
On Windows 10, Windows will _think_ that it can open up the image, but will
actually fail to do so. Use a tool [like OSFMount][osfmount] to mount your
actually fail to do so. Use a tool [like OSFMount][osfmount] to mount your
disk image.
On Linux, search the Internet for instructions on how to mount an `img` disk

View File

@ -1,4 +1,4 @@
Copyright 2018 Felix Rieseberg
Copyright 2019 Felix Rieseberg
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

View File

@ -23,18 +23,23 @@ You'll likely be better off with an actual virtualization app, but the short ans
## Credits
99.999% of the work was done over at [v86](https://github.com/copy/v86/) by Copy.
99% of the work was done over at [v86](https://github.com/copy/v86/) by Copy.
## Contributing
Before you can run this from source, you'll need the disk image. It's not part of the
repository, but you can grab it using the `Show Disk Image` button from the packaged
release, which does include the disk image.
release, which does include the disk image. You can find that button in the
`Modify C: Drive` section.
Unpack the `images` folder into the `src` folder, creating this layout:
```
./src/images/windows95.img
- /images/windows95.img
- /images/default-state.bin
- /assets/...
- /bios/...
- /docs/...
```
Once you've done so, run `npm install` and `npm start` to run your local build.