From 418bdefc91faea3a5467479e8747e15dda2532b6 Mon Sep 17 00:00:00 2001 From: Eduardo Caceres Date: Mon, 30 Mar 2020 21:47:59 +0200 Subject: [PATCH] Add readme file, fix minor issue with pipeline --- .../LichessTournamentAggregator.App.csproj | 2 +- .../LichessTournamentAggregator.csproj | 2 +- README.md | 54 +++++++++++++++++++ azure-pipelines.yml | 2 +- 4 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 README.md diff --git a/LichessTournamentAggregator.App/LichessTournamentAggregator.App.csproj b/LichessTournamentAggregator.App/LichessTournamentAggregator.App.csproj index 566e4c4..0970f0e 100644 --- a/LichessTournamentAggregator.App/LichessTournamentAggregator.App.csproj +++ b/LichessTournamentAggregator.App/LichessTournamentAggregator.App.csproj @@ -6,7 +6,7 @@ win-x64;win-x86;linux-x64;osx-x64 true true - 0.1.0 + 0.1.1 Eduardo Cáceres Multiplatform desktop app that allows you to aggregate the results of multiple Lichess tournaments diff --git a/LichessTournamentAggregator/LichessTournamentAggregator.csproj b/LichessTournamentAggregator/LichessTournamentAggregator.csproj index ae43760..35f76af 100644 --- a/LichessTournamentAggregator/LichessTournamentAggregator.csproj +++ b/LichessTournamentAggregator/LichessTournamentAggregator.csproj @@ -7,7 +7,7 @@ snupkg LichessTournamentAggregator LichessTournamentAggregator - 0.1.0 + 0.1.1 Chess, Lichess, Tournament, Aggregator $(PackageTags) Eduardo Cáceres diff --git a/README.md b/README.md new file mode 100644 index 0000000..a0021ae --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# Lichess Tournament Aggregator + +[![Azure DevOps][azuredevopslogo]][azuredevopslink] +[![Nuget][nugetlogo]][nugetlink] + +[azuredevopslogo]: https://dev.azure.com/eduherminio/LichessTournamentAggregator/_apis/build/status/eduherminio.LichessTournamentAggregator?branchName=master +[azuredevopslink]: https://dev.azure.com/eduherminio/LichessTournamentAggregator/_build/latest?definitionId=1&branchName=master +[nugetlogo]: https://img.shields.io/nuget/v/LichessTournamentAggregator.svg?style=flat-square&label=nuget +[nugetlink]: https://www.nuget.org/packages/LichessTournamentAggregator + +**Lichess Tournament Aggregator** is a simple command line application that uses [Lichess API](https://github.com/lichess-org/api) to aggregate the results of multiple tournaments and write them to a `.csv` file. + +It's also available as a NuGet package. + +## Usage + +Binaries for different operating systems can be found [here](https://github.com/eduherminio/LichessTournamentAggregator/releases). + +- Download the appropiated version. +- Run the executable. +- Enter the tournament urls or ids whose results you want to aggregate (one per line). +- Press double `enter` to start the process. +- If the process has concluded successfully, you should see a `.csv` file placed in the same folder as the executable. +- You can import that `.csv` file from Excel, Google Docs, OpenOffice or your favourite spreadsheet application. Please bear in mind that `;` is the separator you must select if you're given that option. + +Alternatively, tournament urls or ids can be passed to the executable as parameters, i.e.: + +```bash +LichessTournamentAggregator-win-x64.exe 2nu1SO6E https://lichess.org/tournament/8ThpFhld 4R6nkdnI +``` + +## FAQs + +> For which operating systems is the tool available? + +It's currently available for **Windows** (10, 8.1 and 7, for both 32 and 64 bits), **Linux** (Ubuntu, CentOS, Debian, Fedora and derivatives) and **macOS** (macOS 10.12 Sierra and above). If you happen to use another operating system, another architecture (arm) or an older version of macOS, please open an [issue](https://github.com/eduherminio/LichessTournamentAggregator/issues) and I'll be happy to try to help. + +> I'm a Windows user. How do I know which version to use? + +You can check that in `System Information` -> `System type`. Although if you use a reasonably new computer, it's probably going to be x64. + +> I've introduced the tournament urls/ids and nothing's happenning... + +Try pressing enter again. If it still doesn't work and you get no further any other messages in the console, please fill an [issue](https://github.com/eduherminio/LichessTournamentAggregator/issues) and I'll do my best to help you. + +> I've imported the `*.csv` file and the format seems wrong :( + +Please make sure to select `;` as separator when importing the file. + +> The clasification isn't ordered. + +This program won't order the stats of the different players following any specific criteria, you should do that yourself using your spreadsheet editor. + +Feel free to contact or or fill an [issue](https://github.com/eduherminio/LichessTournamentAggregator/issues) if you're struggling to use the application or the NuGet package in any way, I'm always happy to help 😉 diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 0b7b3c3..59486cb 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -94,7 +94,7 @@ stages: displayName: 'Generate executable for $(Windowsx86)' inputs: command: 'publish' - arguments: '--configuration Release --runtime $(Windowsx86) --output $(Build.SourcesDirectory)/LichessTournamentAggregator/Artifacts/$(Windowsx64)' + arguments: '--configuration Release --runtime $(Windowsx86) --output $(Build.SourcesDirectory)/LichessTournamentAggregator/Artifacts/$(Windowsx86)' configuration: '$(BuildConfiguration)' projects: '**/*.App.csproj' modifyOutputPath: false