feat: Add instruction to add content to site

README.md

@@ -1,7 +1,7 @@
 # Progress report
 
-> This repo is a template repository to create your own progress report in markdown.
-> The markdonw will be compiled into a static website using [VitePress](https://vitepress.vuejs.org/).
+> This repo is a template repository to create your own progress report in Markdown.
+> The Markdown will be compiled into a static website using [VitePress](https://vitepress.vuejs.org/).
 > The progress report is a requirement for the CFC of computer scientist applications development in Switzerland.
 
 ## How to use
@@ -23,7 +23,22 @@
 
 ## How to add your content
 
+You can create new markdown files in the `src` folder. You can create subfolders to organise your content.
+You have some default examples in the `src` folder (languages, projects).
+
+You can add images and reference them in your markdown files. You can also add other assets like PDF files.
+
+When you add new pages, you need to add them to the `src/.vitepress/config.mts` file in the `links` constant. See [vitepress documentation](https://vitepress.dev/reference/default-theme-nav#navigation-links) for more details about how to add navigation links.
+
 ## Deployment
 
-Normally, you don't need to deploy your website. It will be automatically deployed by Github Pages when you push your changes to the `main` branch. You can access your website at the following address : `https://<your-github-username>.github.io/<your-repository-name>/`.
+Normally, you don't need to deploy your website. It will be automatically deployed by Github Pages when you push your changes to the `main` branch.
+
+```bash
+git add .
+git commit -m "My changes"
+git push
+```
+
+You can access your website at the following address : `https://<your-github-username>.github.io/<your-repository-name>/`.
 > You may need to activate Github Pages in your repository settings and wait a few minutes for the first build to be completed.