Re-do readme file
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
The actual version of the README.MD is completly out of date with rest of the DAI-Lab projects. It would be good to have a similar verbose read me as the rest of the other projects.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the current README.MD and comparing it with the other DAI-Lab project READMEs linked from the issue. Identify the project details and usage information missing from this repository, then update README.MD so it provides a similarly verbose and current introduction.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100