README doesn't describe the current project #16

New issue

Open

opened 2013-09-05 15:50:59 +00:00 by kanzure · 1 comment

kanzure commented

2013-09-05 15:50:59 +00:00

(Migrated from github.com)

The README is falling behind. The current README is a leftover from pokecrystal/extras/README.md back when everything was shoved into the extras/ path in pokecrystal.

Things the README should include:

installation via pip
use of pokemontools in pokered and pokecrystal
use of pokemontools outside of pokered/pokecrystal
organization of the project
how to run the tests
licensing status
calling preprocessor
calling gbz80disasm

The README is falling behind. The current README is a leftover from pokecrystal/extras/README.md back when everything was shoved into the extras/ path in pokecrystal. Things the README should include: - installation via pip - use of pokemontools in pokered and pokecrystal - use of pokemontools outside of pokered/pokecrystal - organization of the project - how to run the tests - licensing status - calling preprocessor - calling gbz80disasm

zachlatta commented

2014-05-19 19:47:29 +00:00

(Migrated from github.com)

👍

:thumbsup:

This discussion has been locked. Commenting is limited to contributors.