tsrc icon indicating copy to clipboard operation
tsrc copied to clipboard

Improve README

Open dmerejkowsky opened this issue 3 years ago • 1 comments

  • [ ] in "overview" - include link to FAQ in README? Maybe even "why not repo"?
  • [ ] In "usage example" - give a complete example using the whole syntax - for instance with the dummy github manifest
  • [ ] Add a link to the syntax guide

dmerejkowsky avatar Jan 16 '22 13:01 dmerejkowsky

Hi following https://github.com/dmerejkowsky/tsrc/issues/332#issuecomment-1013875390, first sorry one of my link was odd. I fix it. I simply wanted to say that your README starts with:

# tsrc: manage groups of git repositories
...

## Overview

tsrc is a command-line tool that helps you manage groups of several git repositories.

It can be seen in action on asciinema.org.

I would have introduced it more, like this:

# tsrc: manage groups of git repositories
...

## Overview

tsrc is a command-line tool, in the same way of Google's git-repo, that helps you manage groups of several git repositories. It fixes the following main git-repo drawbacks:
- Good support for Windows (no need for Cygwin or anything like that)
- Also, tsrc tries hard to never do any destructive operation or unexpected actions. For instance, tsrc never puts you in a "detached HEAD" state, nor does automatic rebase. It also never touches dirty repositories.
- This is achieved by using mostly 'porcelain' commands from git, instead of relying on plumbings internals.

The sync algorithm is described here: https://dmerejkowsky.github.io/tsrc/ref/sync/
...

It can be seen in action on asciinema.org.
...

Just write on first lines the principal features to tell future users what is tsrc and why they should use :) People are lazy they just read the 2 first lines searching the main information they need. If yes: ok why not trying it and making more effort trying to understand fully the project. If no: skip it and search for the next similar project.

Lecrapouille avatar Jan 16 '22 19:01 Lecrapouille