From e7f79f6a203ea81a809772917735b61ad8fea0db Mon Sep 17 00:00:00 2001 From: Nick Slowinski Date: Fri, 10 May 2024 17:35:23 +0200 Subject: [PATCH] Updating README Signed-off-by: Nick Slowinski --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 24b869e..d18c369 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ -# Wichtige Information +# Welcome to the source of www.nick-slowinski.de -Diese Dokumentation wird momentan mit [Docusaurus](https://docusaurus.io) neugeschrieben und kann daher Lücken von wichtigen Informationen aufweisen. \ No newline at end of file +This website is build with [Docusaurus](docusaurus.io) + +When a branch _main_ is pushed to the repository, an [Action workflow](https://forge.nick-slowinski.de/nick-slowinski.de/www/actions) builds and deploys the new site under [www.nick-slowinski.de](https://www.nick-slowinski.de). + +## Contributing content + +Contributions in any form are gratefully accepted. + +### Adding, extending and changing content + +Fork; Commit changes; Push; Pull request. + +### Translating + +Multilingual functionality is currently planned, but not available. +You can still support us by translating existing content. + +Steps: +1. Fork this repository +2. Duplicate the file in question and rename it like _"forge.{ISO 639-1 language code}.md"_ + - e.g. for an English translation of that file: _forge.en.md_ +3. Push changes to your repository (fork). +4. Create a pull request when you are satisfied with your results. + +# Licence + +Any content, unless otherwise specified, is published under the Creative Commons Attribution 4.0 International (CC BY 4.0) licence. \ No newline at end of file