Rewrite the README to be more clear and concise
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 28/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
The request is to rewrite the project README so it is shorter and clearer about app features. The author already opened pull request 400 with suggested wording, so start by reading that PR and the current README rather than drafting a new rewrite from scratch. Done means maintainers accept a README that is concise and organized; do not duplicate work already in the PR.
Written by the indexing model from the issue text.
Description
Checklist
- I made sure that there are no existing issues - open or closed - to which I could contribute my information.
- I made sure that there are no existing discussions - open or closed - to which I could contribute my information.
- I have read the FAQs inside the app (Menu -> About -> FAQs) and my problem isn't listed.
- I have taken the time to fill in all the required details. I understand that the request will be dismissed otherwise.
- This issue contains only one feature request.
- I have read and understood the contribution guidelines.
Feature description
The current README is very wordy and poorly organized, and is somewhat unclear about certain features, so I think it would be helpful to rewrite it.
Why do you want this feature?
I think it can help make the features of the app clearer for people installing it.
Additional information
I wasn't sure what the best way to contribute this was, so I put my suggested revisions in a pull request. Apologies if this was a better way to contribute this that I should've done.
- Dominant language
- Kotlin
- Stars
- 1k
- Forks
- 98
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 14
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from FossifyOrg/Voice-Recorder
-
bug needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
FossifyOrg/Voice-Recorder#419 ·
Maintainers usually reply within 1 day
-
bug needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
FossifyOrg/Voice-Recorder#411 ·
Maintainers usually reply within 1 day
-
feature request needs triage
Difficulty 4/5 3-5 days Newbie friendliness 55/100
FossifyOrg/Voice-Recorder#441 ·
Maintainers usually reply within 1 day
-
toggle recording via bluetooth remote controlMay be free again A pull request for this issue was closed without being merged. Openfeature request needs triage
Difficulty 4/5 3-5 days Newbie friendliness 48/100
FossifyOrg/Voice-Recorder#436 ·
Maintainers usually reply within 1 day
-
Audio LayeringOpenfeature request needs triage
Difficulty 5/5 Over a week Newbie friendliness 18/100
FossifyOrg/Voice-Recorder#432 ·
Maintainers usually reply within 1 day
All issues in FossifyOrg/Voice-Recorder
Similar issues
-
[Submission] AI服务引擎Opensubmit-adaption submit-adaption-pre
Difficulty 1/5 Under an hour Newbie friendliness 76/100
BetterAndroid/android-notification-icon-project#783 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
coding size:s skill:kotlin-core sub-issue
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SKaiNET-developers/SKaiNET#1421 ·
Maintainers usually reply within 1 day
-
Show Full DetailsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
leonlatsch/Photok#809 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day