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 #164

Merged
merged 1 commit into from
Jul 26, 2024
Merged
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
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,27 @@ From sources
python3 -m pip install --user -e .


For developers
**************

Because many important features of sympde are only tested in psydac, new PRs
must also be tested against the test suite of psydac. This can be done by opening
a PR in psydac where the only change consists of installing the corresponding
branch of sympde.

For instance to test a new sympde branch called ``my_feature``, the following
lines can be used in the file ``.github/workflows/continuous-integration.yml`` of psydac:

.. code-block:: YAML
- name: Download a development version of sympde
working-directory: /tmp
run: |
wget https://github.com/pyccel/sympde/archive/refs/heads/my_feature.zip
unzip ./my_feature.zip
python3 -m pip install ./sympde-my_feature
.. |build-status| image:: https://travis-ci.com/pyccel/sympde.svg?branch=master
:alt: build status
:scale: 100%
Expand Down