search

guyzmo / git-repo

Git-Repo: CLI utility to manage git services from your workspace
https://webchat.freenode.net/?channels=#git-repo
Other
842 stars 85 forks source link

Document 'upstream' special remote #145

Closed jayvdb closed 7 years ago

jayvdb commented 7 years ago

I learnt in https://github.com/guyzmo/git-repo/issues/143#issuecomment-286090012 that upstream is a remote that git-repo uses.

It would be useful to document how this special remote is used.

guyzmo commented 7 years ago

Indeed documentation can definitely be improved (I got to write a proper sphinx doc and push it to readthedocs), meanwhile you might want to read more about the tool in that article I wrote: http://i.got.nothing.to/code/on/git-repo:_the_utility_for_services/

guyzmo commented 7 years ago

I opened an issue about that cf #146

jayvdb commented 7 years ago

Remote upstream could be mentioned in the README now.

guyzmo commented 7 years ago

that's a good idea indeed, and part of the documentation improvement ☺

guyzmo commented 7 years ago

I've added a section on remotes in the readme, up until I actually write the full extensive sphinx documentation.