diff --git a/PokeGuideGenerator.sln b/PokeGuideGenerator.sln index cb01206..daf121e 100644 --- a/PokeGuideGenerator.sln +++ b/PokeGuideGenerator.sln @@ -3,7 +3,12 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 VisualStudioVersion = 16.0.31727.386 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PokeGuideGenerator", "PokeGuideGenerator\PokeGuideGenerator.csproj", "{A259AA2C-39C1-40BD-9A51-01D29FF24562}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PokeGuideGenerator", "PokeGuideGenerator\PokeGuideGenerator.csproj", "{A259AA2C-39C1-40BD-9A51-01D29FF24562}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{4634E51E-BDD9-436B-9CEB-02CB9BAD226B}" + ProjectSection(SolutionItems) = preProject + README.md = README.md + EndProjectSection EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/PokeGuideGenerator/Properties/launchSettings.json b/PokeGuideGenerator/Properties/launchSettings.json index b5232d8..d9df372 100644 --- a/PokeGuideGenerator/Properties/launchSettings.json +++ b/PokeGuideGenerator/Properties/launchSettings.json @@ -2,7 +2,7 @@ "profiles": { "PokeGuideGenerator": { "commandName": "Project", - "commandLineArgs": "-g 3" + "commandLineArgs": "" } } } \ No newline at end of file diff --git a/README.md b/README.md index a69d702..2852153 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,44 @@ # Pokemon Catching Guide -Generate a printable list of Pokemon locations in specific generation. Using .NET/C# and consuming data from [PokeAPI](https://pokeapi.co) by using the [PokeAPI .NET wrapper](https://github.com/mtrdp642/PokeApiNet). -Used to help Catch Em All in every single generation. +Generate a CSV file of the best Pokemon locations in specific generation. Used to help Catch Em All in every single generation. +Using .NET 5.0 and consuming data from [PokeAPI](https://pokeapi.co) by using the [PokeAPI .NET wrapper](https://github.com/mtrdp642/PokeApiNet). +## Installation + +You will need to have [.NET 5.0](https://dotnet.microsoft.com/download/dotnet/5.0) installed to run the console application. + +## Usage + +Generate a CSV file for your generation by downloading the executable or building from the source. + +You may use the following arguments: + +```shell +# -g, --generation Required. Set Pokemon generation (min 1, max 8). +# -s, --side-games Optional. Include side games (like XD/Colloseum). +# --help Display this help screen. +# --version Display version information. +``` + +### Executable + +```shell +cd executable-dir +.\PokeGuideGenerator.exe -g 3 -s +``` + +### Build from source + +```shell +cd pokemon-catch-guide\PokeGuideGenerator +dotnet restore +dotnet build +dotnet run -- -g 3 -s +``` + +## Contributing +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## License +[Apache License 2.0](http://www.apache.org/licenses/) \ No newline at end of file