Skip to content

Commit a723b82

Browse files
committed
Added instructions on downloading single files NO_JIRA
1 parent 0cd84e8 commit a723b82

File tree

3 files changed

+22
-11
lines changed

3 files changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
# CSD Python API Scripts
44

5-
65
A repository containing scripts that have been created to leverage the toolkit found within
76
the [CCDC portfolio](https://www.ccdc.cam.ac.uk/solutions/) that are accessible via
87
the [CSD Python API](https://www.ccdc.cam.ac.uk/solutions/csd-core/components/csd-python-api/).
@@ -29,29 +28,41 @@ Don’t have a licence? Contact us [here to request a quote or demonstration.](h
2928

3029
## Downloading Scripts
3130

32-
This section will focus on how to download multiple or individual scripts:
33-
34-
### 1. Downloading All Scripts
31+
We advise that users `fork` the repository to ensure they can keep up to date with any modification.
32+
If you don't want to worry about having a GitHub account or are not confident with Git, you can download the scripts straight from this webpage.
3533

34+
The following section will outline how to download multiple or individual scripts:
3635

37-
#### Downloading Zip file:
38-
Click `Code` and Select `Download Zip`:
36+
### 1. Downloading All Scripts in a Zip file
3937

40-
<img src="assets/download_zip.png" width="250px">
38+
Whilst in the main repository window click `Code` and select `Download Zip`:
4139

40+
<img src="assets/download_zip.gif" width="300px">
4241

4342
### 2. Downloading Individual Scripts
4443

45-
#### TODO - Add gif of downloading single file
46-
#### TODO - write instructions on how to download
44+
Once you've found a script/file you wish to download, click on it. This will show you the content of the file. In the top right of the file click `Raw`.
45+
This will open the content in a tab where you can `Right-Click` in the text and select `"Save As..."`.
4746

47+
You will be asked to in your file explorer where you wish to save the file. Please specify the file extension at this point, by default `.txt` is used (For python scripts `.py` is required.)
4848

49-
## Running scripts through the CSD Python API Miniconda installed
49+
<img src="assets/single_download.gif" width="500px">
5050

51+
## Running scripts through the CSD Python API Miniconda installed
5152
This requires you to already have the CSD Python API installed.
5253

5354
Windows:
5455
```cmd
5556
"<CCDC_INSTALL_LOCATION>\CCDC\Python_API_2022\miniconda\Scripts\activate.bat"
5657
python script_example.py
57-
```
58+
```
59+
60+
## Submitting or Modifying Scripts
61+
62+
1. [Create a Fork of the repository](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#forking-a-repository) (A fork is a copy of a repository that you manage. Forks let you make changes to a project without affecting the CSD GitHub repo. You can fetch updates from or submit changes to the CSD GitHub repo with pull requests.)
63+
64+
2. [Commit your changes to the forked repository](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-and-pushing-changes) (on a branch).
65+
66+
3. [Create a Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) to this repository.
67+
68+
4. Once the code has been reviewed it can be merged into the CSD GitHub repo by someone from the CCDC.

assets/download_zip.gif

362 KB
Loading

assets/single_download.gif

610 KB
Loading

0 commit comments

Comments
 (0)