Condorcet icon indicating copy to clipboard operation
Condorcet copied to clipboard

Typos & Understandability (documentation, methods names and variables....)

Open julien-boudry opened this issue 2 years ago • 4 comments

Review evrything, evrywhere

julien-boudry avatar Sep 15 '21 10:09 julien-boudry

I have been successfully using this in Github Codespaces. But I haven't managed to get it working on my own computer.

The documentation doesn't explain how I get the vendor directory.

LiamM32 avatar May 13 '23 20:05 LiamM32

Maybe, feel free to open an issue about that. If a new answer is needed.

Look first at: https://www.condorcet.io/2.AsCommandLineApplication/1.Installation

The easier way for you may be to Phar method. But they are all easy.

And to install Composer if needed, see here : https://getcomposer.org/

Also, GitHub Codespace execution is great, and I will document it more, congratulations. But Codespace in web tab, can have little difficulties with interactive shell in some cases.

ps: composer installation is already build in codespace container.

julien-boudry avatar May 13 '23 22:05 julien-boudry

I got it working awhile ago. I don't remember how I solved the problem though.

LiamM32 avatar Jun 04 '23 06:06 LiamM32

The documentation about using the new Condorcet Election Format isn't very good. I think it makes sense that you decided to have only one file for both candidates and votes instead of two. But the page doesn't say what namespace the CondorcetElectionFormat class is in. It's also rather inflexible, as it doesn't provide instructions to use the file format to add candidates and votes to an election object that already started.

LiamM32 avatar Jun 16 '23 07:06 LiamM32