Skip to content

Commit

Permalink
add git pull and colrev update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dengdenglele authored Oct 12, 2023
1 parent 750d6f5 commit a096878
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/source/dev_docs/setup/part_3_colrev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ Install CoLRev with the following commands (using the shell / ``Ctrl``\ +\ ``Alt
cd docs
make html


To test CoLRev in a demo project, run the following commands (using the shell / ``Ctrl``\ +\ ``Alt``\ +\ ``T``):
Test CoLRev in a demo project with the following commands (using the shell / ``Ctrl``\ +\ ``Alt``\ +\ ``T``):

::

Expand All @@ -53,3 +52,14 @@ To test CoLRev in a demo project, run the following commands (using the shell /
colrev init --example
# The status operation will guide you through the whole process
colrev status

Pull the newest changes from the main repository and update CoLRev with the following commands (using the shell / ``Ctrl``\ +\ ``Alt``\ +\ ``T``):

::

# switch to colrev directory. Path may differ, if colrev was setup elsewhere
cd ~/Desktop/colrev
# pull the newest changes and apply the update
git pull
pip install -e .[dev,docs]

0 comments on commit a096878

Please sign in to comment.