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

Improve README.md #59

Open
chschroeder opened this issue Mar 17, 2024 · 0 comments
Open

Improve README.md #59

chschroeder opened this issue Mar 17, 2024 · 0 comments
Labels
feature request New feature request good first issue Good for newcomers non-code contribution Issues that involve little or no coding.

Comments

@chschroeder
Copy link
Contributor

This issue may be amended. It may also be processed partly in single issues if necessary.

Feature description

The README.md is already not bad, but could be greatly improved in some places:

  • Show a (short and concise) code example
  • Provide different entry points for different types of users. Especially there needs to be one entry point for users who are neither developers, nor NLP-researchers, but only want to setup an annotation workflow. (This should be as easy as possible since I have received the feedback that this process is too difficult, and we want to encourage new users to try small-text.)
  • Provide an overview of the current features. I am thinking of a similar table as in the small-text paper (cf. Table 1 here).

Motivation

--

Additional comments

--

@chschroeder chschroeder added feature request New feature request good first issue Good for newcomers non-code contribution Issues that involve little or no coding. labels Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature request good first issue Good for newcomers non-code contribution Issues that involve little or no coding.
Projects
None yet
Development

No branches or pull requests

1 participant