added information for contributors
This commit is contained in:
parent
6fd3a74ff1
commit
329c4e8972
1 changed files with 22 additions and 10 deletions
32
README.md
32
README.md
|
|
@ -1,18 +1,30 @@
|
||||||
# ISPmail guide
|
# 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://github.com/pascal-brand38/astro-splide
|
||||||
- https://pascal-brand38.github.io/astro-dev/packages/astro-splide/
|
- https://pascal-brand38.github.io/astro-dev/packages/astro-splide/
|
||||||
- https://splidejs.com/guides/options/
|
- 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)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue