Skip to content

Commit 644972e

Browse files
authored
Update README with relative path note for scripts
Added a note about using relative paths in the script instructions.
1 parent c5efa24 commit 644972e

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Below are the rough steps needed to complete this assignment, with specific deta
1111

1212
1. Fork the shared training repository to your GitHub account.
1313
2. Clone the repository to your preferred development environment.
14-
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`.
14+
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.
1515
4. Commit the new script on your fork of the repository.
1616
5. Push the new commit to your fork on GitHub.
1717
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.
@@ -23,8 +23,7 @@ Below are the rough steps needed to complete this assignment, with specific deta
2323

2424
## Example Decryption function
2525

26-
```
27-
python
26+
```python
2827
# Simple function to decrypt a string by shifting the ascii code by some value (key)
2928
def decrypt(encrypted_message:str, key:int) -> str:
3029
message = ""
@@ -33,4 +32,4 @@ def decrypt(encrypted_message:str, key:int) -> str:
3332
decrypted_char = chr((ord(char) - key) % 126)
3433
message += decrypted_char
3534
return message
36-
```
35+
```

0 commit comments

Comments
 (0)