README.md intro text
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reading the introduction in README.md and compare it with the linked explanation. Rewrite the opening so it explains what sshuttle does and presents the operating-system details as requirements rather than the use case. Done means a newcomer can understand the project's purpose from the README intro.
Written by the indexing model from the issue text.
Description
I come from https://github.com/sshuttle/sshuttle_rust and did not understand what the project is about, then i googled 'sshuttle' and landed here: https://github.com/sshuttle/sshuttle
But I don't understand it either.
If this is a nice explanation, could you copy it to the README.md maybe?
For instance the first point on the README.md:
As far as I know, sshuttle is the only program that solves the following common case:
- Your client machine (or router) is Linux, FreeBSD, or MacOS.
I don't think that having a machine running Linux or any other OS is a good use-case to reference what sshuttle can do for me. It is rather a requirement I guess.
I hope this helps, please don't be offended, just want to help you to understand why I don't get your README.md description.
- Dominant language
- Python
- Stars
- 13.6k
- Forks
- 795
- Avg merge
- 10h 48m
- Merged PRs (30d)
- 15
Contributor guide
No contributing guide indexed for this repository
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 sshuttle/sshuttle
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
All issues in sshuttle/sshuttle
Similar issues
-
bug confirmed issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
open-webui/open-webui#30750 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
OpenwaterHealth/openmotion-bloodflow-app#604 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
good first issue
Difficulty 1/5 Under an hour Newbie friendliness 90/100