Update README.md
This commit is contained in:
James Groom
GitHub
parent
41f464b80c
commit
73366ef5af
60
README.md
60
README.md
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
A multi-system emulator written in C#. As well as quality-of-life features for casual players, it also has recording/playback and debugging tools, making it the first choice for TASers (Tool-Assisted Speedrunners).
|
||||
|
||||
[](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores)
|
||||
[](#cores)
|
||||
[](https://github.com/TASVideos/BizHawk/releases/latest)
|
||||
[](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history)
|
||||
[](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest)
|
||||
|
|
@ -17,19 +17,19 @@ New user on Windows? Install the prerequisites first, click the "prereqs" button
|
|||
|
||||
Jump to:
|
||||
* Installing
|
||||
* [Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110)
|
||||
* [GNU+Linux](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux)
|
||||
* [Windows 7/8.1/10](#windows-78110)
|
||||
* [GNU+Linux](#gnulinux)
|
||||
* Building
|
||||
* [Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110-1)
|
||||
* [GNU+Linux](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1)
|
||||
* [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage)
|
||||
* [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing)
|
||||
* [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing)
|
||||
* [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores)
|
||||
* [Support and troubleshooting](https://github.com/TASVideos/BizHawk/blob/master/README.md#support-and-troubleshooting)
|
||||
* [Contributing](https://github.com/TASVideos/BizHawk/blob/master/README.md#contributing)
|
||||
* [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects)
|
||||
* [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license)
|
||||
* [Windows 7/8.1/10](#windows-78110-1)
|
||||
* [GNU+Linux](#gnulinux-1)
|
||||
* [Usage](#usage)
|
||||
* [TASing](#tasing)
|
||||
* [Testing](#testing)
|
||||
* [Cores](#cores)
|
||||
* [Support and troubleshooting](#support-and-troubleshooting)
|
||||
* [Contributing](#contributing)
|
||||
* [Related projects](#related-projects)
|
||||
* [License](#license)
|
||||
|
||||
## Features and systems
|
||||
|
||||
|
|
@ -81,9 +81,9 @@ Supported consoles and computers:
|
|||
* Uzebox
|
||||
* [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..?
|
||||
|
||||
See [*Usage*](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) below for details about specific tools and config menus.
|
||||
See [*Usage*](#usage) below for details about specific tools and config menus.
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
## Installing
|
||||
|
||||
|
|
@ -109,7 +109,7 @@ Following [Microsoft's support lifecycle](https://support.microsoft.com/en-us/he
|
|||
|
||||
A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag/1.13.2), is available for Windows XP and 32-bit users. Being in the 1.x series, many bugs remain and features are missing.
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
### GNU+Linux
|
||||
|
||||
|
|
@ -117,7 +117,7 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag
|
|||
|
||||
**IMPORTANT**: Linux support is a work-in-progress! It is *not* complete, does *not* look very nice, and is *not* ready for anything that needs accuracy.
|
||||
|
||||
You'll need to either build BizHawk yourself (see [*Building*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below).
|
||||
You'll need to either build BizHawk yourself (see [*Building*](#gnulinux-1) below), or download a dev build (see [*Testing*](#testing) below).
|
||||
|
||||
The runtime dependencies are Mono (complete) + Mono VB.NET, WINE (just `libwine` if available), `libdl.so` (glibc), NVIDIA's `cgc` utility, and `libblip_buf.so` from the repo's `Assets` folder (copy it to `/usr/lib/libblip_buf.so.1.1.0` or equivalent). LSB release info is optional for automatically setting the library location.
|
||||
|
||||
|
|
@ -125,7 +125,7 @@ Run `EmuHawkMono.sh` to give Mono the library and executable paths — you can r
|
|||
|
||||
The systems that currently work are: GB + GBC (GBHawk), NES (NesHawk), SMS, Atari 7800, and some classic home computers. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress.
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
## Building
|
||||
|
||||
|
|
@ -142,7 +142,7 @@ Once it's downloaded and extracted, go into the repo's `Dist` folder and run `Bu
|
|||
|
||||
For anything more complicated than building, you'll need an IDE like [VS Community 2017](https://visualstudio.microsoft.com/vs/community), currently the best free C# IDE. Open `BizHawk.sln` with VS to start and use the toolbar to choose EmuHawk and build. See [Compiling at TASVideos](http://tasvideos.org/Bizhawk/Compiling.html) (somewhat outdated) for more detailed instructions.
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
### GNU+Linux
|
||||
|
||||
|
|
@ -161,11 +161,11 @@ Remove the `/p:...` flag from MSBuild if you want debugging symbols.
|
|||
|
||||
If your distro isn't listed under *Installing* above, `libblip_buf` probably isn't in your package repos. You can easily [build it yourself](https://gitlab.com/TASVideos/libblip_buf/blob/unified/README.md).
|
||||
|
||||
Once built, see [*Installing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux) above, substituting the repo's `output` folder for the download.
|
||||
Once built, see [*Installing*](#gnulinux) above, substituting the repo's `output` folder for the download.
|
||||
|
||||
Again, if your distro isn't listed there, you might get an "Unknown distro" warning in the terminal, and BizHawk may not open or may show the missing dependencies dialog. You may need to add your distro to the case statement in the script, setting `libpath` to the location of `d3dx9_43.dll.so` (please do share if you get it working).
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -208,7 +208,7 @@ Running scripts have a "▶️" beside their name, and stopped scripts (manually
|
|||
|
||||
"Toggle script" does just that (paused scripts are stopped). "Reload script" stops it and loads changes to the file, running scripts are then started again. "Remove script" stops it and removes it from the list.
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
### TASing
|
||||
|
||||
|
|
@ -216,17 +216,17 @@ Running scripts have a "▶️" beside their name, and stopped scripts (manually
|
|||
|
||||
For now, the best way to learn how to TAS is to browse pages like [BasicTools](http://tasvideos.org/TasingGuide/BasicTools.html) on TASVideos and watch tutorials like [Sand_Knight and dwangoAC's](https://youtu.be/6tJniMaR2Ps).
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
### Testing
|
||||
|
||||
Testing bugfixes or new features can be just as helpful as making them! If code's more your thing, see [*Contributing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#contributing) below.
|
||||
Testing bugfixes or new features can be just as helpful as making them! If code's more your thing, see [*Contributing*](#contributing) below.
|
||||
|
||||
Dev builds are automated with AppVeyor, every green checkmark in the [commit history](https://github.com/TASVideos/BizHawk/commits/master) is a successful build. Clicking a checkmark and then "Details" in the box that appears takes you straight to the build page. The full list is [here](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history), in future use the "dev builds" button at the top of this readme.
|
||||
|
||||
Once you're on the build page, click "Artifacts" and download `BizHawk_Developer-<datetime>-#<long hexadecimal>.zip`.
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
### Cores
|
||||
|
||||
|
|
@ -264,7 +264,7 @@ ZX Spectrum | ZXHawk |
|
|||
|
||||
Amstrad CPC, Magnavox Odyssey², and PSP emulation are works-in-progress and there is **no ETA**. Cores for other systems are only conceptual. If you want to help speed up development, ask on IRC (see below).
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
## Support and troubleshooting
|
||||
|
||||
|
|
@ -276,19 +276,19 @@ A short [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) is provided on the [BizHawk
|
|||
|
||||
If there's no easy solution, what you've got is a bug. Or maybe a feature request. Either way, [open a new issue](https://github.com/TASVideos/BizHawk/issues/new) (you'll need a GitHub account, signup is very fast).
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
## Contributing
|
||||
|
||||
BizHawk is Open Source Software, so you're free to modify it however you please, and if you do, we invite you to share! Under the permissive *MIT License*, this is optional, just be careful with reusing cores as some have copyleft licenses.
|
||||
|
||||
Not a programmer? Something as simple as reproducing bugs with different software versions is still very helpful! See [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) above to learn about dev builds if you'd rather help us get the next release out.
|
||||
Not a programmer? Something as simple as reproducing bugs with different software versions is still very helpful! See [*Testing*](#testing) above to learn about dev builds if you'd rather help us get the next release out.
|
||||
|
||||
If you'd like to fix bugs, check the issue tracker here on GitHub:
|
||||
|
||||
[](https://github.com/TASVideos/BizHawk/issues)
|
||||
|
||||
It's a good idea to check if anyone is already working on an issue by asking on IRC (see [*Support*](https://github.com/TASVideos/BizHawk/blob/master/README.md#support-and-troubleshooting) above).
|
||||
It's a good idea to check if anyone is already working on an issue by asking on IRC (see [*Support*](#support-and-troubleshooting) above).
|
||||
|
||||
If you'd like to add a feature, first search the issue tracker for it. If it's a new idea, make your own feature request issue before you start coding.
|
||||
|
||||
|
|
@ -296,7 +296,7 @@ For the time being, style is not enforced in PRs, only build success is. Please
|
|||
|
||||
Past contrbutors to the frontend and custom-built cores are listed [here](https://github.com/TASVideos/BizHawk/graphs/contributors). See the wiki for core authors.
|
||||
|
||||
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
|
||||
[to top](#bizhawk)
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue