Browse Source

Update 'README.md'

ๅคฉ้—ฎ 2 years ago
parent
commit
0f3e99a03c
1 changed files with 143 additions and 1 deletions
  1. 143 1
      README.md

+ 143 - 1
README.md

@@ -1,3 +1,145 @@
 # windows95
 
-๐Ÿ’ฉ๐Ÿš€ Windows 95 in Electron. Runs on macOS, Linux, and Windows.
+This is Windows 95, running in an [Electron](https://electronjs.org/) app. Yes, it's the full thing. I'm sorry.
+
+## Downloads
+
+<table class="is-fullwidth">
+</thead>
+<tbody>
+</tbody>
+  <tr>
+    <td>
+      <img src="./.github/images/windows.png" width="24"><br />
+      Windows
+    </td>
+    <td>
+      <span>32-bit</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-3.1.1-setup-ia32.exe">
+        ๐Ÿ’ฟ Installer
+      </a> |
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-win32-ia32-3.1.1.zip">
+        ๐Ÿ“ฆ Standalone Zip
+      </a>
+      <br />
+      <span>64-bit</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-3.1.1-setup-x64.exe">
+        ๐Ÿ’ฟ Installer
+      </a> |
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-win32-x64-3.1.1.zip">
+        ๐Ÿ“ฆ Standalone Zip
+      </a><br />
+      <span>ARM64</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-3.1.1-setup-arm64.exe">
+        ๐Ÿ’ฟ Installer
+      </a> |
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-win32-arm64-3.1.1.zip">
+        ๐Ÿ“ฆ Standalone Zip
+      </a><br />
+      <span>
+        โ“ Don't know what kind of chip you have? Hit start, enter "processor" for info.
+      </span>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <img src="./.github/images/macos.png" width="24"><br />
+      macOS
+    </td>
+    <td>
+      <span>Intel Processor</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-darwin-x64-3.1.1.zip">
+        ๐Ÿ“ฆ Standalone Zip
+      </a><br />
+      <span>Apple M1 Processor</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-darwin-arm64-3.1.1.zip">
+        ๐Ÿ“ฆ Standalone Zip
+      </a><br />
+      <span>
+        โ“ Don't know what kind of chip you have? Learn more at <a href="https://support.apple.com/en-us/HT211814">apple.com</a>.
+      </span>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <img src="./.github/images/linux.png" width="24"><br />
+      Linux
+    </td>
+    <td>
+      <span>64-bit</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-3.1.1-1.x86_64.rpm">
+        ๐Ÿ’ฟ rpm
+      </a> |
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95_3.1.1_amd64.deb">
+        ๐Ÿ’ฟ deb
+      </a><br />
+      <span>ARM64</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-3.1.1-1.arm64.rpm">
+        ๐Ÿ’ฟ rpm
+      </a> |
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95_3.1.1_arm64.deb">
+        ๐Ÿ’ฟ deb
+      </a><br />
+      <span>ARMv7 (armhf)</span>
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95-3.1.1-1.armv7hl.rpm">
+        ๐Ÿ’ฟ rpm
+      </a> |
+      <a href="https://github.com/felixrieseberg/windows95/releases/download/v3.1.1/windows95_3.1.1_armhf.deb">
+        ๐Ÿ’ฟ deb
+      </a>
+    </td>
+  </tr>
+</table>
+
+<hr />
+
+![Screenshot](https://user-images.githubusercontent.com/1426799/44532591-4ceb3680-a6a8-11e8-8c2c-bc29f3bfdef7.png)
+
+## Does it work?
+Yes! Quite well, actually - on macOS, Windows, and Linux. Bear in mind that this is written entirely in JavaScript, so please adjust your expectations.
+
+## Should this have been a native app?
+Absolutely.
+
+## Does it run Doom (or my other favorite game)?
+You'll likely be better off with an actual virtualization app, but the short answer is yes. [Thanks to
+@DisplacedGamers](https://youtu.be/xDXqmdFxofM) I can recommend that you switch to a resolution of
+640x480 @ 256 colors before starting DOS games - just like in the good ol' days.
+
+## Credits
+
+99% of the work was done over at [v86](https://github.com/copy/v86/) by Copy aka Fabian Hemmer and his contributors.
+
+## 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. You can find that button in the
+`Modify C: Drive` section.
+
+Unpack the `images` folder into the `src` folder, creating this layout:
+
+```
+- /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.
+
+If you want to tinker with the image or make a new one, check out the [QEMU docs](./docs/qemu.md).
+
+## Other Questions
+
+ * [MS-DOS seems to brick the screen](./HELP.md#ms-dos-seems-to-brick-the-screen)
+ * [Windows 95 is stuck in a bad state](./HELP.md#windows-95-is-stuck-in-a-bad-state)
+ * [I want to install additional apps or games](./HELP.md#i-want-to-install-additional-apps-or-games)
+ * [Running in Docker](./docs/docker-instructions.md)
+ * [Running in an online VM with Kubernetes and Gitpod](./docs/docker-kubernetes-gitpod.md)
+
+## License
+
+This project is provided for educational purposes only. It is not affiliated with and has
+not been approved by Microsoft.