add proper readme file

This commit is contained in:
c 2023-06-08 15:36:43 +02:00
parent da6fa1a0e8
commit bd10b00f95
1 changed files with 10 additions and 1 deletions

View File

@ -1,3 +1,12 @@
# onFOSS.org
This is the main homepage of the onFOSS organization. It is build with Jekyll.
This is the main homepage of the onFOSS organization. It is build with [Jekyll](https://jekyllrb.com/).
## Contribution
This is the repository for the sourcecode of the homepage. If you want to contribute install Jekyll and always test with `bundle exec jekyll serve` if the site is running.
## Deployment
To deploy the homepage, you have to build the site with `bundle exec jekyll build` and copy the `_site` directory into the [deploy repostitory](https://git.libregaming.org/onFOSS/onFOSS.org-Deploy). The changes are getting deployed every 10 minutes automatically.
## Atribution
We use [Bootstrap](https://getbootstrap.com/) that is licenced as MIT.