wearing_sound_projects

https://wearablecomputing.github.io/wearing_sound_projects/

Step 1: Prepare the Project Folder

Verify Archive Folder

• Check the "archive" folder to see if there is a folder for the current course year, e.g., "2023-2024". If such a folder does not exist, create it.

Add Project to Course Folder

• Place your project folder inside the respective course year folder.

Set Up Images Folder

• Inside your project folder, create a subfolder named "Images".
• Copy all relevant images to the "Images" folder.

Step 2: Preprocess Media Files

Preprocess Images

• Navigate to the project root directory.
• Execute the preprocessing script by running: sh ./archive/image-preprocessing.sh This script uses ImageMagick to convert images to webp format and creates different resolutions. Ensure the script completes successfully.

Select and Rename Title Image

• Go to the newly created "medium" subfolder within "Images".
• Select one image to be the title image and rename it to "title_img.webp".

Preprocess Audio Files (if applicable)

• If your project includes audio files, run the following at the project root: sh ./archive/audio-preprocessing.sh

Step 3: Create Project Post

Prepare Markdown File

• Navigate to the "_posts" folder.
• Create a new markdown (.md) file for the project. Use an existing post as a template.
• Make sure to stick to the naming convention of the .md file ("2024-01-01-project title" for a project in the course "2024/2025")
• Also make sure that the project name in the .md file name matches the folder name in /archive folder
• Replace the template content with the new project information.

Step 4: Finalize and Publish

Commit Changes

• Review your changes to ensure all new files are added and existing files are correctly updated.
• Commit the changes to your local git repository with a meaningful commit message.

Push to GitHub

• Push the committed changes to the GitHub repository to update the online project archive.

Additional Tips

Check Consistency

• Always compare the structure and formatting with existing projects in the archive to ensure consistency.

Test Locally

• Use Jekyll commands (bundle exec jekyll serve or jekyll serve) to test the project locally before pushing changes to ensure that everything displays correctly on the website. Note: When testing locally, images that are not yet pushed to GitHub are not displayed.