Add some images to help first time git users

Author: robtaylor

README.md

@@ -1,20 +1,24 @@
-# Chipflow Examples
+# ChipFlow Examples
 
 ## Install Requirements
- * Install the latest version of Python installed [Python Downloads](https://www.python.org/downloads/).
- * Ensure you have git command line tools installed [Git Downloads](https://git-scm.com/downloads).
- * We reccomend VS Code as a development environment [VSCode Downloads](https://code.visualstudio.com/download).
- * Github Desktop is a great tool for cloning git repos [Github Desktop Downloads](https://desktop.github.com/download/)
+ * Install the latest version of Python: [Python Downloads](https://www.python.org/downloads/).
+ * Ensure you have git command line tools installed: [Git Downloads](https://git-scm.com/downloads).
+ * We recommend VS Code as a development environment: [VSCode Downloads](https://code.visualstudio.com/download).
+ * GitHub Desktop is a great tool for cloning git repos: [GitHub Desktop Downloads](https://desktop.github.com/download/)
 
 ## Clone this repository
-If you're familiar withi the [git](https://git-scm.com/) command line then you'll know what to do, otherwise install [GitHub Desktop](https://github.com/apps/desktop). Once its installed, lauch it. You will be asked to sign in or create an account - we reccomend you take this moment to create a GitHub account if you don't already have one.
+If you're familiar with the [Git](https://git-scm.com/) command line then you'll know what to do, otherwise install [GitHub Desktop](https://github.com/apps/desktop). Once its installed, launch it. You will be asked to sign in or create an account - we recommend you take this moment to create a GitHub account if you don't already have one.
 
-Come back to [this page](https://github.com/ChipFlow/chipflow-examples) and click the green 'Code' button at the top. Select  'Open with Github Desktop' and follow the prompts. Once Github Desktop has cloned your repo you can click the button to open it in VSCode.
+Come back to [this page](https://github.com/ChipFlow/chipflow-examples) and click the green 'Code' button at the top. Select  'Open with GitHub Desktop' and then follow the prompts (N.B. your web browser may have a pop-up to authorise opening an external app)
+![Image showing the link to click](docs/assets/open-github-desktop.png)
 
-## Install the dependancies
-In VScode, open up a terminal from the title menu bar, or using a terminal of your choice.
+Once GitHub Desktop has cloned your repo you can click the button to open it in VS Code:
+![Image showing where to click in GitHub Desktop to open in VSCode](docs/assets/github-desktop-open.png)
 
-We use [PDM](https://pdm-project.org) to manage our dependancies, so this will need to be installed. Follow the [PDM install instructions](https://pdm-project.org/en/latest/#installation)
+## Install the dependencies
+In VS Code, open up a terminal from the title menu bar, or using a terminal of your choice.
+
+We use [PDM](https://pdm-project.org) to manage our dependencies, so this will need to be installed. Follow the [PDM install instructions](https://pdm-project.org/en/latest/#installation)
 
 Once PDM is installed, make sure your in the `chipflow-examples` directory and then run:
 ```
@@ -23,19 +27,21 @@ pdm install
 ```
 
 ## Set up the environment
-Generate your API key at https://build-staging.chipflow.org/user/detail
+Generate your API key at https://build.chipflow.org/user/detail. Click on 'Create/Refresh API Key', and your new API key will appear at the top. Copy it now, as you will not see it again!
+
+![Image showing a newly generated API Key](docs/assets/api-key.png)
 
-Create a file called `.env` at the top level in the `chipflow-examples` directory, containing the line below, subsituting your key from the page above:
+Create a file called `.env` at the top level in the `chipflow-examples` directory, containing the line below, substituting your key from the page above:
 
 ```
 CHIPFLOW_API_KEY=<Paste your key here>
 ```
 
-## Running ChipFlow 
+## Running a chip build
 
 First choose a design to test. Here we will use the `minimal` design.
 
-Change into the `minimal` directory in `chipflow-examples` to use this design. Now we need to 'lock' our pins - the chipflow tooling will then automatically allocate inputs and outputs from your design to pins on the chip.
+Change into the `minimal` directory in `chipflow-examples` to use this design. Now we need to 'lock' our pins - the ChipFlow tooling will then automatically allocate inputs and outputs from your design to pins on the chip.
 
 ```
 pdm run chipflow pin lock
@@ -80,7 +86,7 @@ Design submitted successfully! Build URL: https://build-staging.chipflow.org//bu
 
 Your design will now start building: pictures and logs of the build are available at build URL that is returned, once it is complete.
 
-If you would like to get the build logs streamed to your commandline, you can instead call:
+If you would like to get the build logs streamed to your command-line, you can instead call:
 ```
 pdm run chipflow silicon submit --wait
 ```