From a45c28d47ed2dfd744a2c1f02fa72e28926ad57d Mon Sep 17 00:00:00 2001 From: Frank Steinberg <steinberg@ibr.cs.tu-bs.de> Date: Thu, 3 Oct 2019 22:17:29 +0200 Subject: [PATCH] Updated text. --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index bfe088c..3880b57 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This is a new approach to achieve two goals: -- tranlating BJCP documents (primarily the beer styleguide 2015) to the German language, +- tranlating BJCP documents (primarily the beer styleguide 2015) to the German language (in a war that easily allows to add further languages), - establishing an XML form of the styleguide in order to support a flexible transformation architecture for a variety of destination formats. ## Concept & Roadmap @@ -24,26 +24,28 @@ This is a new approach to achieve two goals: - Download and unarchive this project and enter its directory. - Simply run ```make``` + Don't care about lots of warning about missing external entities (files). These are the missing translation snippets that we have to supply step by step. - You will now find: - The original complete styleguide in XML representation: `bjcp-2015-styleguide-orig.xml` - - The broken-down original content as category, subcategory, and "subsubcategory" snippet in directory: `orig` -- Now, you can gradually add and update translated content in directory: `de`. The structure should match that in `orig`. XML elements not present in the translated files will be copied from the `orig` data, when the translated styleguide will be generated. Never change XML element names and the XML structure, never change `id` attributes, never add `tags` or `vital statistics`to the translated files, they will be used from the original data. -- To see the results of your translation work, you can re-run `make` at any time and look at `bjcp-2015-styleguide-de.xml` -- (nicely formated output documents will follow.) + - The broken-down original content as category, subcategory, and "subsubcategory" snippets in the directory: `orig` + - A (partially) translated XML styleguid: `bjcp-2015-styleguide-de.xml` +- Now, you can gradually add and update translated content in the directory `de`. The structure should match `orig`. XML elements not present in the translated files will be copied from the `orig` data, when the translated styleguide will be generated. Never change XML element names or the XML structure, never change `id` attributes, never add `tags` or `specs` (Vital Statistics) to the translated files, they will be used from the original data. +- To see the results of your translation work, you can re-run `make` at any time. ## Contact -This stuff has been initiated by the German homebrewer community at https://hobbybrauer.de and its HBCon organization team. +This stuff has been initiated by the German homebrewing community at https://hobbybrauer.de and its HBCon organization team. Contact: -- Nils Vogel <nils.vogel@gmx.net> -- Frank Steinberg <frank@familie-steinberg.org> +- Nils Vogel <nils.vogel@gmx.net> (primary HBCon contact) +- Frank Steinberg <frank@familie-steinberg.org> (coding this XML magic) ## TODO -Pay special attention to: - -- specs: Saison (standard, pale, dark, ...) -- specs: Lambic (varies w/ fruit) -- specs: Tropical Stout (missing some numbers) -- specs: Specialty IPA (Strength classification) +- Add clear words to honor the original BJCP word. +- Care about copyright questions. Add LICENSE file. +- pay special attention to: + - specs: Saison (standard, pale, dark, ...) + - specs: Lambic (varies w/ fruit) + - specs: Tropical Stout (missing some numbers) + - specs: Specialty IPA (Strength classification) -- GitLab