Update README.md

This commit is contained in:
Kaphotics 2016-09-17 08:50:34 -07:00 committed by GitHub
parent af22a1577c
commit 0b4cc06da2

View File

@ -1,41 +1,36 @@
PKHeX
=====
![License](https://img.shields.io/badge/License-GPLv3-blue.svg)
Pokémon GBA/NDS/3DS save editor, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29).
Pokémon core series save editor, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29).
Supports the following files originating from the Nintendo GBA, NDS, & 3DS:
Supports the following files:
* Save files ("main", .sav)
* Individual Pokémon entity files (.pk*)
* Mystery Gift files (.pgt, .pcd, .pgf, .wc6) including conversion to .pk*
* Importing teams from Decrypted Battle Videos (X/Y/OR/AS only)
* Transferring of previous generation entities (.pkm) to future generation formats and save files
* Transferring from one generation to another, converting formats along the way.
Data is displayed in a view which can be edited and saved.
The interface can be translated with resource/external text files so that different languages can be supported.
Pokémon Showdown sets can be imported/exported in addition to QR codes.
Pokémon Showdown sets and QR codes can be imported/exported to assist in sharing.
Nintendo 3DS savedata containers use an AES MAC that cannot be emulated without the 3DS's keys, thus a resigning service is required (svdt, save_manager, or SaveDataFiler).
## Screenshots
![Main Window](http://i.imgur.com/GBub4le.png)
### License
PKHeX is licensed under GPLv3. Refer to LICENSE.md for more information.
![Main Window](http://i.imgur.com/QT3IxpR.png)
## Building
PKHeX can be compiled with any compiler that supports C# 6.0.
PKHeX is a Windows Forms application which requires .NET Framework v4.0.
The executable can be built with any compiler that supports C# 6.0.
### IDE
PKHeX can be opened with MS Visual Studio and [MonoDevelop](http://www.monodevelop.com/) by importing the project with the .sln or .csproj file.
### Command Line
You can use [xbuild of Mono](http://mono-framework.com/Microsoft.Build): `xbuild PKHeX.sln`.
PKHeX can be opened with IDEs such as [Visual Studio](https://www.visualstudio.com/) or [MonoDevelop](http://www.monodevelop.com/) by opening the .sln or .csproj file.
### GNU/Linux