schapps/README.md

46 lines
956 B
Markdown
Raw Normal View History

# Schapps Publication
Schapps site and publication.
2024-05-24 13:11:16 +02:00
## About
This repository contains the official Schapps publication which is kindly
sponsored by WPN, and hosted at https://schapps.woodpeckersnest.eu
2024-05-24 13:11:16 +02:00
2024-05-24 14:56:02 +02:00
## Contributing
2024-05-24 13:11:16 +02:00
Anyone is welcome to submit code that fixes problems and improve things.
You can also submit redesigns, yet first open an issue report informing us,
preferably with an example.
2024-05-24 13:11:16 +02:00
## Building
The site utilizes [Nikola](https://getnikola.com) as a static site generator.
2024-05-24 13:11:16 +02:00
To generate the site, execute the following command inside the repository
directory:
2024-05-24 13:11:16 +02:00
```shell
nikola build
```
The site is generated under the directory `output`.
You can also execute the following to start up a local development server:
```shell
nikola serve -b
```
2024-05-24 14:56:02 +02:00
## Updating
```shell
git init
git checkout -b main
git add *
git commit -m "Description of action"
git remote add origin https://git.xmpp-it.net/sch/schapps.git
2024-05-24 14:56:02 +02:00
git push -u origin main
```