flycast/README.md

# Flycast

[![Android CI](https://github.com/flyinghead/flycast/actions/workflows/android.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/android.yml)
[![C/C++ CI](https://github.com/flyinghead/flycast/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/c-cpp.yml)
[![Nintendo Switch CI](https://github.com/flyinghead/flycast/actions/workflows/switch.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/switch.yml)
[![Windows UWP CI](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml)

![flycast logo](https://github.com/flyinghead/flycast/raw/master/shell/linux/flycast.png)

**Flycast** is a multi-platform Sega Dreamcast, Naomi, Naomi 2, and Atomiswave emulator derived from [**reicast**](https://github.com/skmp/reicast-emulator).

Information about configuration and supported features can be found on [**TheArcadeStriker's flycast wiki**](https://github.com/TheArcadeStriker/flycast-wiki/wiki).

Join us on our [**Discord server**](https://discord.gg/X8YWP8w) for a chat. 

## Install

### Flatpak (Linux ![ubuntu logo](https://flyinghead.github.io/flycast-builds/ubuntu.png))

1. [Set up Flatpak](https://www.flatpak.org/setup/).

2. Install Flycast from [Flathub](https://flathub.org/apps/details/org.flycast.Flycast):

`flatpak install -y org.flycast.Flycast`

3. Run Flycast:

`flatpak run org.flycast.Flycast`

### Homebrew (MacOS ![apple logo](https://flyinghead.github.io/flycast-builds/apple.png))

1. [Set up Homebrew](https://brew.sh).

2. Install Flycast via Homebrew:

`brew install --cask flycast`

### Xbox One/Series ![xbox logo](https://flyinghead.github.io/flycast-builds/xbox.png)

#### Retail:
Open [**gamr13's github page**](https://gamr13.github.io/) from your Xbox console.

#### Dev Mode:
Grab the latest build from [**the builds page**](https://flyinghead.github.io/flycast-builds/), or the [**GitHub Actions**](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml). Then install it using the **Xbox Device Portal**.

### Binaries ![android](https://flyinghead.github.io/flycast-builds/android.jpg) ![windows](https://flyinghead.github.io/flycast-builds/windows.png) ![linux](https://flyinghead.github.io/flycast-builds/ubuntu.png) ![apple](https://flyinghead.github.io/flycast-builds/apple.png) ![switch](https://flyinghead.github.io/flycast-builds/switch.png) ![xbox](https://flyinghead.github.io/flycast-builds/xbox.png)

Get fresh builds for your system [**on the builds page**](https://flyinghead.github.io/flycast-builds/).

**New:** Now automated test results are available as well. 

### Build instructions:
`git clone https://github.com/flyinghead/flycast.git`

`cd flycast`

`git submodule update --init --recursive`

`mkdir build && cd build`

`cmake ..`

`make`
Enhance markdown sections 2021-04-19 08:47:45 +00:00			`# Flycast`

Add CI badges 2021-04-19 08:54:03 +00:00			`[![Android CI](https://github.com/flyinghead/flycast/actions/workflows/android.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/android.yml)`
README.md: add Nintendo Switch CI badge 2021-09-25 15:50:01 +00:00			`[![C/C++ CI](https://github.com/flyinghead/flycast/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/c-cpp.yml)`
			`[![Nintendo Switch CI](https://github.com/flyinghead/flycast/actions/workflows/switch.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/switch.yml)`
README.md: add badge for Windows UWP CI 2021-12-19 11:50:22 +00:00			`[![Windows UWP CI](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml/badge.svg)](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml)`
Add CI badges 2021-04-19 08:54:03 +00:00
Enhance markdown sections 2021-04-19 08:47:45 +00:00			`![flycast logo](https://github.com/flyinghead/flycast/raw/master/shell/linux/flycast.png)`
update some READMEs 2020-11-21 16:59:52 +00:00
Readme Updates. (#659) * Update Reicast Link 2022-06-05 15:32:59 +00:00			`Flycast is a multi-platform Sega Dreamcast, Naomi, Naomi 2, and Atomiswave emulator derived from [reicast](https://github.com/skmp/reicast-emulator).`
Add Discord link. non-functional changes 2019-09-27 20:00:52 +00:00
Add CI badges 2021-04-19 08:54:03 +00:00			`Information about configuration and supported features can be found on [TheArcadeStriker's flycast wiki](https://github.com/TheArcadeStriker/flycast-wiki/wiki).`
Update README.md 2020-04-06 10:04:54 +00:00
Add Discord link. non-functional changes 2019-09-27 20:00:52 +00:00			`Join us on our [Discord server](https://discord.gg/X8YWP8w) for a chat.`
project import 2013-12-19 17:10:14 +00:00
Enhance markdown sections 2021-04-19 08:47:45 +00:00			`## Install`

UWP build fix. Readme update 2023-02-16 10:14:01 +00:00			`### Flatpak (Linux ![ubuntu logo](https://flyinghead.github.io/flycast-builds/ubuntu.png))`
Add Flatpak installation guide 2021-04-19 09:00:30 +00:00
Readme Updates. (#659) * Update Reicast Link 2022-06-05 15:32:59 +00:00			`1. [Set up Flatpak](https://www.flatpak.org/setup/).`
Add Flatpak installation guide 2021-04-19 09:00:30 +00:00
Readme Updates. (#659) * Update Reicast Link 2022-06-05 15:32:59 +00:00			`2. Install Flycast from [Flathub](https://flathub.org/apps/details/org.flycast.Flycast):`
Add Flatpak installation guide 2021-04-19 09:00:30 +00:00
			`flatpak install -y org.flycast.Flycast`

Readme Updates. (#659) * Update Reicast Link 2022-06-05 15:32:59 +00:00			`3. Run Flycast:`
Add Flatpak installation guide 2021-04-19 09:00:30 +00:00
			`flatpak run org.flycast.Flycast`

UWP build fix. Readme update 2023-02-16 10:14:01 +00:00			`### Homebrew (MacOS ![apple logo](https://flyinghead.github.io/flycast-builds/apple.png))`
Add installation on MacOS via Homebrew 2022-02-24 17:22:28 +00:00
Readme Updates. (#659) * Update Reicast Link 2022-06-05 15:32:59 +00:00			`1. [Set up Homebrew](https://brew.sh).`
Add installation on MacOS via Homebrew 2022-02-24 17:22:28 +00:00
Readme Updates. (#659) * Update Reicast Link 2022-06-05 15:32:59 +00:00			`2. Install Flycast via Homebrew:`
Add installation on MacOS via Homebrew 2022-02-24 17:22:28 +00:00
			`brew install --cask flycast`

UWP build fix. Readme update 2023-02-16 10:14:01 +00:00			`### Xbox One/Series ![xbox logo](https://flyinghead.github.io/flycast-builds/xbox.png)`
readme: link to gamr13's xbox page 2021-12-22 20:41:01 +00:00
(README) Update Xbox Section 2022-06-01 22:55:25 +00:00			`#### Retail:`
			`Open [gamr13's github page](https://gamr13.github.io/) from your Xbox console.`

			`#### Dev Mode:`
			`Grab the latest build from [the builds page](https://flyinghead.github.io/flycast-builds/), or the [GitHub Actions](https://github.com/flyinghead/flycast/actions/workflows/uwp.yml). Then install it using the Xbox Device Portal.`
readme: link to gamr13's xbox page 2021-12-22 20:41:01 +00:00
UWP build fix. Readme update 2023-02-16 10:14:01 +00:00			`### Binaries ![android](https://flyinghead.github.io/flycast-builds/android.jpg) ![windows](https://flyinghead.github.io/flycast-builds/windows.png) ![linux](https://flyinghead.github.io/flycast-builds/ubuntu.png) ![apple](https://flyinghead.github.io/flycast-builds/apple.png) ![switch](https://flyinghead.github.io/flycast-builds/switch.png) ![xbox](https://flyinghead.github.io/flycast-builds/xbox.png)`
Enhance markdown sections 2021-04-19 08:47:45 +00:00
android: bigger on-screen gamepad analog handle. Update project README 2021-12-24 18:46:09 +00:00			`Get fresh builds for your system [on the builds page](https://flyinghead.github.io/flycast-builds/).`
Update README.md 2019-07-02 10:17:03 +00:00
dummy commit 2022-01-29 18:39:08 +00:00			`New: Now automated test results are available as well.`
Update README.md 2023-06-14 17:47:33 +00:00
			`### Build instructions:`
			`git clone https://github.com/flyinghead/flycast.git`

			`cd flycast`

			`git submodule update --init --recursive`

			`mkdir build && cd build`

			`cmake ..`

			`make`