search

jalanb / cde

cde extends cd, historically
MIT License
2 stars 0 forks source link

Improve documentation #1

Open jalanb opened 11 years ago

jalanb commented 11 years ago

kd is now big enough to need better documentation that just a docstring and a readme file.

Suggested

  1. Ensure readme is consistent with docstring
  2. Rethink both from user's POV
  3. Add documentation for installation
  4. Consider ReadTheDocs and even a man page