Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

detailed documentation #19

Open
FilLupin opened this issue Feb 7, 2015 · 0 comments
Open

detailed documentation #19

FilLupin opened this issue Feb 7, 2015 · 0 comments

Comments

@FilLupin
Copy link

FilLupin commented Feb 7, 2015

I think it could be usefull to write a doc of this tool to help users to identify issues :

  • some of them are just due to a misunderstanding of the usage message
  • some of them are due to a bad configuration
  • some others are probably due to some bugs

I think this doc should gather :

  • an installation guide (i.e "pip install sms-tools")
  • the steps to follow to get the infile and to test outfile, and what should be the result
  • how to use runalltests.py and give the results with conveniant information to undersand what occured
  • a list of the error messages to understand better the script outputs

Here are some firsts thoughs which could probably help with the use of this script and relieve you for basic questions.
t413 : could you just say us if you are OK with giving us these informations to be able to use your work? Even if you do not have time actually, just to know if we should have hope that we can use it in a few weeks/months

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

No branches or pull requests

1 participant