diff --git a/README.md b/README.md index 02d8ee8..d5f49b7 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,17 @@ [Storm Website](https://www.stormchecker.org) ============================================ -> :warning: Only push changes to the **`website/src`** branch. Any edits in **`website/build`** will be overwritten. - # How it works -On every push to `website/src`, the website is automatically build using [jekyll](https://jekyllrb.com) and GitHub Actions. The generated files are then automatically pushed to `website/build`. +On every push to `main`, the website is automatically build using [jekyll](https://jekyllrb.com) and GitHub Actions, and afterwards deployed. Note that the whole deployment process takes a few minutes. # Contributing -The easiest way to suggest changes and additions to the website is to fork this repository and create a pull request to `website/src`. +The easiest way to suggest changes and additions to the website is to fork this repository and create a pull request to `main`. Of course, you can also write us an email :email: `support at stormchecker.org` # Building the website locally If you want to check your local changes before making them public, you have to install [jekyll and its prerequisites](https://jekyllrb.com/docs/installation/). -Make sure to be in the `storm` directory with the `website/src` branch checked out. You can then use the provided Gemfile in the directory via: ```console bundle install