atiran/porymap
3
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
huderlem 2021-01-20 13:21:51 -06:00 committed by GitHub
parent 3bf4aaf964
commit 2bf33a14b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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