From 329c4e89727087f0f4e8f37805abecb57af7d3b3 Mon Sep 17 00:00:00 2001 From: Christoph Haas Date: Fri, 28 Nov 2025 15:55:41 +0100 Subject: [PATCH] added information for contributors --- README.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b4c182f..26e60e8 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,30 @@ # ISPmail guide -This repository holds the ISPmail guide as found on workaround.org. +This repository contains the ISPmail guide as found on workaround.org. -It was built using the static site generator [Starlight](https://starlight.astro.build). +The web site is built the static site generator [Starlight](https://starlight.astro.build) which creates beautiful +documentation with table of contents, a search function and customizable widgets. -More information on how to contribute will follow. +The illustrations were created using DrawIO. The flip-book-style diagrams on the _big picture_ page were created using: -# Software used - -Static site generator: https://starlight.astro.build/ - -Diagrams/Illustrations: - -- DrawIO - https://github.com/pascal-brand38/astro-splide - https://pascal-brand38.github.io/astro-dev/packages/astro-splide/ - https://splidejs.com/guides/options/ + +## Contributing + +Feel free to clone this repository (the _prod_ branch) and make changes. You will need NodeJS to create the HTML from +the sources: + +```sh +apt install nodejs +npm i +npm run dev +``` + +Merge requests are always welcome. Typo fixes and rephrasing are always welcome because I am not a native english +speaker. If you want to contribute or change larger sections please talk to me first. + +Or just create an _issue_ here on Github so that I know what needs fixing. + +…[Christoph](mailto:ispmail@christoph-haas.de)