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.

Sign up for GitHub

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

Jump to bottom

README Improvements #1

Closed

ijacobs-cpa opened this issue Sep 15, 2023 · 1 comment

ijacobs-cpa commented Sep 15, 2023 •

edited

The included README.md could use the following improvements/additions:

Include any details about commands that can be used in your program (ex -v,-h)
Including examples of running the program.
installation instructions (Including how to clone from GitHub / check that Python is installed. etc.)
include some more explanation on how to use the program including limits on what the program can do and any features it has.

Also in the example shown on how to run the program the name of the main file (text2html.py) is misspelled (should be txt2html.py)

Owner

mingming-ma commented Sep 16, 2023

README Improvements in the commit 4d8fd71

mingming-ma closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment