search

lincolncosta / moba.aid

🎮 MOBA Artificial Intelligence Draft (AID) is an API using genetic algorithm to suggest League of Legends champions pick on the draft based on factors like the enemy team, the already picked champions and others.
https://moba-aid.herokuapp.com/api/docs
16 stars 5 forks source link

Reescrever documentação #8

Closed lincolncosta closed 4 years ago

lincolncosta commented 5 years ago

Reescrever documentação explicando melhor os fluxos e os parâmetros necessários para execução. Também evidenciar quais são as saídas (arquivos com resultados) obtidas.

santospatrick commented 4 years ago

Tenho interesse em melhorar a documentação. Acredito que seria legal também criar uma versão CLI desse projeto e publicar em alguma store, para que usuários possam rodar os comandos sem nem precisar rodar um npm install. Já existem ferramentes no mercado que geram documentação e a flag --help com instruções automaticamente como Inquirer e Yargs

lincolncosta commented 4 years ago

@santospatrick, ótimas sugestões. Colaborações são sempre bem-vindas, fique à vontade caso queira aplicar as ferramentas que sugeriu.

Após melhorias no sentido de execução, também preciso melhorar a documentação do funcionamento do projeto.

lincolncosta commented 4 years ago

Documentação atualizada à partir do commit https://github.com/tekpixo/moba.aid/commit/038eab80e220f440fc7d80f80019d3f551d4efb2.