Updated Home (markdown)

mborgerson 2020-05-25 23:05:11 -07:00
parent e145e4e3ce
commit 52dce6d0c5
1 changed files with 25 additions and 9 deletions

34
Home.md

@ -32,13 +32,18 @@ Lots of great things. If you've subscribed to my [YouTube channel](https://www.y
Along the way, I plan to catalog and demonstrate reasonably often, which includes posting more demo videos on YouTube of stuff you can try for yourself. I also look forward to seeing your videos of testing things out so we can hunt bugs together.
Download/Build
--------------
Download
--------
Users are encouraged to help regularly test for regressions. I plan to release the compatibility system soon where reports and videos can be shared documenting progress. In the mean time, feel free to report issues in the Discord server linked at the top of this page.
### Windows
Windows users are recommended to use the pre-built release version. The link to this can be found at the top of this page. However, if you would like to build from source, you can do so by downloading the [MSYS2 environment](https://www.msys2.org/) and building with:
[![Download](https://img.shields.io/badge/Download-Windows-blue?logo=Windows)](https://github.com/mborgerson/xemu/releases/latest)
The latest pre-built release version is recommended. Simply follow the download link to the Releases page, download the release for Windows, extract the archive, and launch xemuw.exe.
#### Building from Source
If you would like to build from source, you can do so by downloading the [MSYS2 environment](https://www.msys2.org/) and building with:
```bash
pacman --needed --noconfirm -S git make \
@ -54,7 +59,13 @@ pacman --needed --noconfirm -S git make \
```
### macOS
macOS users are recommended to use the pre-built release version. The link to this can be found at the top of this page. However, if you would like to build from source, you can do so by first installing the [Homebrew package manager](https://brew.sh/) and building with:
[![Download](https://img.shields.io/badge/Download-macOS-blue?logo=Apple)](https://github.com/mborgerson/xemu/releases/latest)
The latest pre-built release version is recommended. Simply follow the download link to the Releases page, download the release for macOS, extract the archive, then you can drag the *xemu* app to your Applications folder.
#### Building from Source
If you would like to build from source, you can do so by first installing the [Homebrew package manager](https://brew.sh/) and building with:
```bash
brew update
@ -63,17 +74,22 @@ brew install glib pixman sdl2 libepoxy coreutils pkg-config dylibbundler
```
### Linux (Debian/Ubuntu)
Users running Ubuntu are recommended to use the PPA to easily install the pre-built release version:
```
[![Download](https://img.shields.io/badge/Download-Ubuntu%20PPA-orange?logo=ubuntu)](https://launchpad.net/~mborgerson/+archive/ubuntu/xemu)
Users running recent versions of Ubuntu (18.04 and newer) are recommended to install through the daily build PPA repository. At the command line, run the following:
```bash
sudo add-apt-repository ppa:mborgerson/xemu
sudo apt-get update
sudo apt install xemu
xemu
```
Users of other Linux distributions will need to build from source. Instructions depend
on platform. The following instructions are for Ubuntu:
You can now launch xemu through your typical launcher, or by typing `xemu` at the command line.
#### Building from Source
If you are not using Ubuntu, or would prefer to build from source, you can do so with:
```bash
sudo apt-get update