ImperialCollegeLondon / ImperialCollegeLondon/python-template
Separate out instructions in README.md for template users and their users
- Dominant language
- Python
- Stars
- 14
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Specifically, the README tells users to run `git init`, which you will want to do if you have just created a new project using the template, but if you're someone using this repo, you don't want to run `git init`! Instead you should clone the repo first.
Maybe we should have separate sections in the README?
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading README.md and identify the instructions intended for people creating a project from the template versus people using this repository directly. Separate those workflows so template users are directed to git init while repository users are directed to clone the repo, then verify both paths are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100