Skip to content

docs: clarify fork before clone in installation instructions#24

Open
Jah-yee wants to merge 2 commits intoTheCraigHewitt:mainfrom
Jah-yee:fix/docs-fork-instruction
Open

docs: clarify fork before clone in installation instructions#24
Jah-yee wants to merge 2 commits intoTheCraigHewitt:mainfrom
Jah-yee:fix/docs-fork-instruction

Conversation

@Jah-yee
Copy link

@Jah-yee Jah-yee commented Mar 13, 2026

Summary

Add explicit instruction to fork the repository before cloning, and include optional upstream remote configuration for pulling latest changes from the original repo.

Changes

  • Modified README.md installation section to clarify:
    1. Users should fork first before cloning
    2. Added optional upstream remote setup

Testing

  • Documentation renders correctly

Closes #22

Jah-yee and others added 2 commits March 12, 2026 02:53
asyncio is part of Python's standard library (since Python 3.4) and
should not be listed as a dependency. This removes the incorrect
dependency that could cause confusion during installation.
Add explicit instruction to fork the repository before cloning,
and include optional upstream remote configuration for pulling
latest changes from the original repo.

Closes TheCraigHewitt#22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants