Skip to content

Updated README NO_JIRA#1

Merged
apeel-ccdc merged 4 commits into
mainfrom
tidy-up
Oct 3, 2025
Merged

Updated README NO_JIRA#1
apeel-ccdc merged 4 commits into
mainfrom
tidy-up

Conversation

@apeel-ccdc

Copy link
Copy Markdown
Contributor

No description provided.

Comment thread README.md
Python scripts relating to the CSD Python API for virtual workshops, self-guided workshops, videos and educational tutorials.
# CSD Python API Tutorials

<img src="assets/csd-python-api-logo.png" width="100px">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: img]

Comment thread README.md
Python scripts relating to the CSD Python API for virtual workshops, self-guided workshops, videos and educational tutorials.
# CSD Python API Tutorials

<img src="assets/csd-python-api-logo.png" width="100px">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD045/no-alt-text Images should have alternate text (alt text)

@apeel-ccdc
apeel-ccdc requested a review from ctovee October 2, 2025 16:34
Comment thread README.md
This will open the content in a tab where you can `Right-Click` in the text and select `"Save As..."`.

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.)
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 on the download button.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Comment thread README.md

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.)
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 on the download button.
This will open a file explorer. Click `"Save As..."` to save the script.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Comment thread README.md
This will open a file explorer. Click `"Save As..."` to save the script.

<img src="assets/single_download.gif" width="500px">
<img src="assets/download_single_script.gif" width="500px">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: img]

Comment thread README.md
This will open a file explorer. Click `"Save As..."` to save the script.

<img src="assets/single_download.gif" width="500px">
<img src="assets/download_single_script.gif" width="500px">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD045/no-alt-text Images should have alternate text (alt text)

Comment thread README.md
<img src="assets/single_download.gif" width="500px">
<img src="assets/download_single_script.gif" width="500px">

## Running scripts through the CSD Python API Miniconda installed

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Comment thread README.md
<img src="assets/single_download.gif" width="500px">
<img src="assets/download_single_script.gif" width="500px">

## Running scripts through the CSD Python API Miniconda installed

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Running scripts through the CSD Python API Miniconda installed"]

Comment thread README.md
Comment on lines +44 to +45
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 on the download button.
This will open a file explorer. Click `"Save As..."` to save the script.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint-fix] reported by reviewdog 🐶

Suggested change
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 on the download button.
This will open a file explorer. Click `"Save As..."` to save the script.
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 on the download button.
This will open a file explorer. Click `"Save As..."` to save the script.

Comment thread README.md
<img src="assets/single_download.gif" width="500px">
<img src="assets/download_single_script.gif" width="500px">

## Running scripts through the CSD Python API Miniconda installed

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint-fix] reported by reviewdog 🐶

Suggested change
## Running scripts through the CSD Python API Miniconda installed
## Running scripts through the CSD Python API Miniconda installed

@apeel-ccdc
apeel-ccdc merged commit b0a4ccf into main Oct 3, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants