From 1d347112cb017e7be9ea15b67f0eec82812cfa62 Mon Sep 17 00:00:00 2001 From: Nelle Varoquaux Date: Tue, 27 May 2025 11:30:46 +0200 Subject: [PATCH] Added a README on how to compile the website --- .gitignore | 3 ++- README.md | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 5e1523f..af6dd12 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,5 @@ vendor .Rproj.user -.fake \ No newline at end of file +.fake +.env-secret diff --git a/README.md b/README.md index f728959..55475a2 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,28 @@ This repository stores the source of Computorg. + +## How to contribute to the website: + +- install quarto +- install dotnet-sdk-8.0 + + ```bash + sudo apt-get install dotnet-sdk-8.0 + ``` + +- create an API key on github + + - go to your settings + - Then developer settings + - Then create a github token + +- Put the token in .env-secret in the root of this repository + + ```bash + GITHUB_TOKEN=your_github_token + ``` + +- Now, you can compile the website with + + quarto-render