Skip to content

Update README with relative path note for scripts #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k-florek merged 1 commit into from
Jan 8, 2026
Merged

Update README with relative path note for scripts #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Below are the rough steps needed to complete this assignment, with specific deta

1. Fork the shared training repository to your GitHub account.
2. Clone the repository to your preferred development environment.
3. Create a script in **bash** or **python** in the `workshop_scripts` directory which decodes your chunk stored in the `encrypted_data` folder and outputs the decoded text into the `workshop_data` directory using the `[key].txt` format i.e. `2.txt`.
3. Create a script in **bash** or **python** in the `workshop_scripts` directory which decodes your chunk stored in the `encrypted_data` folder and outputs the decoded text into the `workshop_data` directory using the `[key].txt` format i.e. `2.txt`. Note: use relative paths in your script, the absolute path will be different on everyone's machine.
4. Commit the new script on your fork of the repository.
5. Push the new commit to your fork on GitHub.
6. Create pull request in the [StaPH-B/2026-amd-git-workshop](https://github.com/StaPH-B/2026-amd-git-workshop) on GitHub to merge changes from your fork into the shared training repository.
Expand All @@ -23,8 +23,7 @@ Below are the rough steps needed to complete this assignment, with specific deta

## Example Decryption function

```
python
```python
# Simple function to decrypt a string by shifting the ascii code by some value (key)
def decrypt(encrypted_message:str, key:int) -> str:
message = ""
Expand All @@ -33,4 +32,4 @@ def decrypt(encrypted_message:str, key:int) -> str:
decrypted_char = chr((ord(char) - key) % 126)
message += decrypted_char
return message
```
```
Loading