Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

README doesn't describe the current project #16

Open
kanzure opened this issue Sep 5, 2013 · 1 comment
Open

README doesn't describe the current project #16

kanzure opened this issue Sep 5, 2013 · 1 comment

Comments

@kanzure
Copy link
Member

kanzure commented Sep 5, 2013

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
Copy link

👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants