Merge pull request 'add a readme to the visual repo' (#1) from tyboro-patch-1 into master

Reviewed-on: #1
This commit is contained in:
tyboro 2024-12-03 18:12:40 +01:00
commit 9bce099a8e

45
README.md Normal file
View file

@ -0,0 +1,45 @@
# Poster Folder Structure
The posters from this repo will be parsed for SCC.
To ensure proper organization and accessibility for SCC, follow these steps to structure the folders for event posters:
## Folder Structure
1. **Year Folder**
- Create a folder named with the academic year in the format `20XX-20XX`. For example:
- `2023-2024`
- `2024-2025`
2. **Event Folder**
- Inside each year folder, create a folder for each event. The folder name should match the event title as displayed on the website. For example:
- `Lightning Tutorials`
- `Board Game Night`
3. **Poster File**
- Inside the event folder, add the poster image. The file must be named `scc.png`. For example:
- `20XX-20XX/Lightning Tutorials/scc.png`
## Example Structure
```
2023-2024/
Lightning Tutorials/
scc.png
Board Game Night/
scc.png
2024-2025/
Coding Workshop/
scc.png
Movie Night/
scc.png
```
## Notes
- Ensure all folder and file names are accurate and match the required format.
- The poster file must be in **PNG format** and named exactly `scc.png` (case-sensitive).
- Update the folder names if the event title changes on the website.
By following this structure, the system will properly locate and use the event posters.