diff --git a/README.rst b/README.rst index 63adbec0..5dbd1bfe 100644 --- a/README.rst +++ b/README.rst @@ -41,20 +41,26 @@ Note Installation ------------- -The recommended way to install ``tsrc`` is to use `pipx `_ - * Make sure to have Python **3.7** or later installed. -* Install ``pipx`` +* Run ``pip install tsrc``. + + +Alternatively we recommend to use `pipx `_ if you have it installed. + * Run ``pipx install tsrc``. + + Usage Example ------------- -* Create a *manifest* repository. (``git@example.org/manifest``) +* Create a *manifest* repository. (``git@example.org/manifest.git``) + +* Add a file named ``manifest.yml`` at the root of the *manifest* repository. -* Push a file named ``manifest.yml`` looking like: +``manifest.yml``: .. code-block:: yaml @@ -65,6 +71,9 @@ Usage Example - url: git@example.com/bar.git dest: bar +It is convenient while optional to include the manifest repository itself in your ``manifest.yml``. It will allow you to have a local copy of you manifest repository to easily make changes to it in the future. + +* commit your ``manifest.yml`` and push the changes to the manifest repository. * Create a new workspace with all the repositories listed in the manifest: @@ -83,6 +92,7 @@ Usage Example Done ✓ + * Synchronize all the repositories in the workspace: .. code-block:: console