Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.rst #366

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,26 @@ Note
Installation
-------------

The recommended way to install ``tsrc`` is to use `pipx <https://pipxproject.github.io/pipx/>`_

* Make sure to have Python **3.7** or later installed.
* Install ``pipx``
* Run ``pip install tsrc``.


Alternatively we recommend to use `pipx <https://pipxproject.github.io/pipx/>`_ if you have it installed.

* Run ``pipx install tsrc``.




Usage Example
-------------


* Create a *manifest* repository. (``[email protected]/manifest``)
* Create a *manifest* repository. (``[email protected]/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

Expand All @@ -65,6 +71,9 @@ Usage Example
- url: [email protected]/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:

Expand All @@ -83,6 +92,7 @@ Usage Example
Done ✓



* Synchronize all the repositories in the workspace:

.. code-block:: console
Expand Down