From 2bf33a14b851fc7349e99b6d17bcd283356ce9cb Mon Sep 17 00:00:00 2001 From: huderlem Date: Wed, 20 Jan 2021 13:21:51 -0600 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f1bd58d1..43a8f4a7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -# porymap +# Porymap [![Actions Status](https://github.com/huderlem/porymap/workflows/Build%20Porymap/badge.svg)](https://github.com/huderlem/porymap/actions) -A map editor for the generation 3 decompilation projects using Qt. +A map editor for the Pokémon generation 3 decompilation projects ([pokeruby][pokeruby], [pokeemerald][pokeemerald], and [pokefirered][pokefirered]). -Currently supports [pokeruby][pokeruby], [pokeemerald][pokeemerald], and [pokefirered][pokefirered]. - -Documentation: https://huderlem.github.io/porymap/ +To get started, view the full online guide here: https://huderlem.github.io/porymap/ View the [Changelog][changelog] to see what's new, and download the latest version from the [Releases][releases]. +![Porymap Preview](docsrc/manual/images/introduction/porymap-loaded-project.png) + +## Local Development + +Read [INSTALL.md](INSTALL.md) for instructions on how to compile Porymap from source. If you simply want to use Porymap, download the latest version from the [Releases][releases]. + [pokeruby]: https://github.com/pret/pokeruby [pokeemerald]: https://github.com/pret/pokeemerald [pokefirered]: https://github.com/pret/pokefirered