chore: added localisation info to README (closes #302)

README.md

@@ -7,9 +7,12 @@ This repo is the core of the [NFDI4Chem knowledge base](https://knowledgebase.nf
 ## Documentation
 
 - [Getting started](./readme/getting_started.md)
+- [Localisation](./readme/localisation.md)
 - [Advanced stuff](./readme/advanced.md)
 - [Local testing](./readme/testing.md)
 
+[![Crowdin](https://badges.crowdin.net/nfdi4chem-knowledge-base/localized.svg)](https://crowdin.com/project/nfdi4chem-knowledge-base)
+
 ## Acknowledgments
 
 Funded by the German Research Foundation (DFG).

readme/getting_started.md

@@ -4,23 +4,26 @@
 
 Just follow these simple steps:
 
-1. Create a fork of the repository.
+1. Create a [fork](https://github.com/NFDI4Chem/knowledge_base/fork) of the repository.
 2. Make additions/changes as required.
-3. Create a pull-request.
+3. Create a pull-request to [`NFDI4Chem/knowledge_base:localisation`](https://github.com/NFDI4Chem/knowledge_base/tree/localisation).  
+   _(If you don't know how change the base of your pull request, don't worry - we will re-route your pull request if it is not pointed at that branch.)_
 
 Your changes will then be reviewed by editors of this page. In case of any problems, or if you are unable to contribute via github contact [[email protected]](mailto:[email protected]).
 
+After approval, the changed sources will be forwarded for [localisation](./localisation.md) and finally merged into the `main` branch.
+
 ## Conventions
 
-- Use british english
-- headings with: # (primary), ## (secondary), ### (tertiary etc)
+-   Use british english
+-   headings with: # (primary), ## (secondary), ### (tertiary etc)
 
 ## Source information
 
-- Citations (e.g. for journal articles): only cite the name of the article and doi (if available) and add link to doi - as opposed to a citation standard such as Angewandte, RSC etc. To cite to a footnote   which contains a citation, use a superscripted number.
-- For references, sources and/or further information/reading, please always use the heading "Sources and further information".
-- Use bullet points
-- Indicate if a source is written in German (e.g. - German: Article about ...)
+-   Citations (e.g. for journal articles): only cite the name of the article and doi (if available) and add link to doi - as opposed to a citation standard such as Angewandte, RSC etc. To cite to a footnote which contains a citation, use a superscripted number.
+-   For references, sources and/or further information/reading, please always use the heading "Sources and further information".
+-   Use bullet points
+-   Indicate if a source is written in German (e.g. - German: Article about ...)
 
 ## Adding images
 
@@ -35,6 +38,8 @@ Please place your image files in the suitable subfolder for the topic of your ar
 
 You can then reference to them by leaving out the `/static` part of the path. Preferably add images using the Markdown syntax like this:
 
-```![FAIR Data](/img/topics/FAIR_data_principles.png)```
+```
+![FAIR Data](/img/topics/FAIR_data_principles.png)
+```
 
 Using the `img` HTML tag will require additional prerequisites and is discouraged unless specifically needed for the page layout. If you have special formatting matters, please contact [us](mailto:[email protected]).

readme/localisation.md

@@ -0,0 +1,15 @@
+# Localisation
+
+[![Crowdin](https://badges.crowdin.net/nfdi4chem-knowledge-base/localized.svg)](https://crowdin.com/project/nfdi4chem-knowledge-base)
+
+The NFDI4Chem Knowledge Base is currently offered in [English](https://knowledgebase.nfdi4chem.de/knowledge_base/) and [German](https://knowledgebase.nfdi4chem.de/knowledge_base/de/).
+
+## How does it work?
+
+We use a [Crowdin project](https://crowdin.com/project/nfdi4chem-knowledge-base) for translating all pages. Whenever new contents are merged to the [`localisation`](https://github.com/NFDI4Chem/knowledge_base/tree/localisation) branch, the English sources are automatically uploaded to Crowdin for translation.
+
+As soon as the translation is finished, the branch localisation will be merged into the [`main`](https://github.com/NFDI4Chem/knowledge_base/tree/main) branch. The public website will subsequently be automatically rebuilt with the English sources and the translations downloaded from Crowdin.
+
+## How can I contribute to translating?
+
+Please get in touch with [us](mailto:[email protected]), we will invite you as a member in the Crowdin project and discuss all important issues.