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

Add example usage to readme #2

Open
rlskoeser opened this issue Jan 31, 2025 · 0 comments
Open

Add example usage to readme #2

rlskoeser opened this issue Jan 31, 2025 · 0 comments

Comments

@rlskoeser
Copy link

Documentation review for openjournals/joss-reviews#7596

The JOSS software draft paper includes usage instructions for the library as both a command-line tool and as a python library, but the readme in the repository only includes installation instructions. The usage instructions should be made available directly from the repository, either in the readme or somewhere easily accessible from the readme.

I don't think this level of usage information is needed in the JOSS paper, so it may be that you can simply move the usage instructions from the JOSS paper into the readme. Be sure to update to reflect the package rename from stylotool to freestylo.

The JOSS paper indicates that either spaCy or cltk can be used for preprocessing; it would be nice to provide examples of these.

It would also be helpful to provide a high-level list of supported stylistic devices in the readme and ensure that the documentation makes it possible for any of the supported modes to be used.

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