Skip to content
This repository was archived by the owner on Jul 26, 2026. It is now read-only.

Revise and update the readme#103

Merged
Byron merged 1 commit into
gitpython-developers:masterfrom
EliahKagan:update-readme
Oct 20, 2023
Merged

Revise and update the readme#103
Byron merged 1 commit into
gitpython-developers:masterfrom
EliahKagan:update-readme

Conversation

@EliahKagan

@EliahKagan EliahKagan commented Oct 20, 2023

Copy link
Copy Markdown
Member

Changes worth mentioning:

  • Format commands as code blocks instead of blockquotes. (This is particularly useful for the submodule update step, whose lines were inadvertently concatenated, but it also improves appearance overall.)
  • Mention smmap as a requirement. (But also that it doesn't need to be separately installed.)
  • Mention that gitdb-speedups is not currently maintained.
  • No longer say gitdb has source code in gitorious. (Since that site no longer exists.)
  • Call GitPython "GitPython" rather than "git-python".
  • Replace the old git-python Google Groups link with a link to the Discussions page on the GitHub repository for GitPython. (This seems like the closest currently available resource.)

Please note that this does not make any changes related to #102.

Changes worth mentioning:

- Format commands as code blocks instead of blockquotes.
  (This is particularly useful for the submodule update step, whose
  lines were inadvertently concatenated, but it also improves
  appearance overall.)

- Mention smmap as a requirement.
  (But also that it doesn't need to be separately installed.)

- Mention that gitdb-speedups is not currently maintained.

- No longer say gitdb has source code in gitorious.
  (Since that site no longer exists.)

- Call GitPython "GitPython" rather than "git-python".

- Replace the old git-python Google Groups link with a link to the
  Discussions page on the GitHub repository for GitPython.
  (This seems like the closest currently available resource.)

@Byron Byron left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, appreciated!

@Byron
Byron merged commit 3753f72 into gitpython-developers:master Oct 20, 2023
@EliahKagan
EliahKagan deleted the update-readme branch October 20, 2023 15:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants