Skip to content

Commit b9e5804

Browse files
committed
Update so that folk check out the 'release' branch
Also remove spurious "Installation" instructions at end
1 parent 37b9666 commit b9e5804

File tree

1 file changed

+3
-18
lines changed

1 file changed

+3
-18
lines changed

docs/getting-started.rst

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Clone chipflow-examples
2929

3030
.. note::
3131
If you’re familiar with the `Git <https://git-scm.com/>`__ command line
32-
then go clone `ChipFlow/chipflow-examples <https://github.com/ChipFlow/chipflow-examples>`
32+
then go clone `ChipFlow/chipflow-examples <https://github.com/ChipFlow/chipflow-examples>`,
33+
switch to the `release branch <https://github.com/ChipFlow/chipflow-examples/tree/release>`,
3334
and jump ahead to `Install the Dependencies`_
3435

3536

@@ -39,7 +40,7 @@ it you will be asked to sign in or create an account - we recommend you
3940
take this moment to create a GitHub account if you don’t already have
4041
one!
4142

42-
Navigate to `the chipflow-examples repository <https://github.com/ChipFlow/chipflow-examples>`__
43+
Navigate to `the chipflow-examples repository release branch <https://github.com/ChipFlow/chipflow-examples/tree/release>`__
4344
and click the green ‘Code’ button at the top. Select ‘Open with GitHub Desktop’ and
4445
then follow the prompts (N.B. your web browser may have a pop-up to
4546
authorise opening an external app)
@@ -165,19 +166,3 @@ you can instead call:
165166
.. |Image showing the link to click| image:: _assets/open-github-desktop.png
166167
.. |Image showing where to click in GitHub Desktop to open in VSCode| image:: _assets/github-desktop-open.png
167168

168-
169-
Installation
170-
------------
171-
172-
1. Clone the ChipFlow repository:
173-
174-
.. code-block:: bash
175-
176-
git clone https://github.com/ChipFlow/chipflow-lib.git
177-
cd chipflow-lib
178-
179-
2. Install dependencies using PDM:
180-
181-
.. code-block:: bash
182-
183-
pdm install

0 commit comments

Comments
 (0)