From 6f178c06d7b2bc5e75ac472abe73bd9bc44842bc Mon Sep 17 00:00:00 2001 From: axherrm Date: Sun, 4 Feb 2024 11:43:09 +0100 Subject: [PATCH] update README.md --- README.md | 41 ++++++----------------------------------- 1 file changed, 6 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 12ee8fb..10fccb6 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,9 @@ -# CV - Axel Herrmann +# CV - Axel Herrmann -This is the development project for the Curriculum Vitae of Axel Herrmann. -See the newest deployed version at https://axherrm.github.io/CV/ - -## How to fill the template - -All data displayed on the CV is stored in [src/data]. -Use the following steps to insert your own data: -> ### 1. [general.json] -> -> This file contains a definition of the languages that can be used in the CV as well as a definition of section headings etc. for each language. -> If all languages you want to use are defined you only need to adjust the languages array. -> -> | Field | Description | -> |-----------------------|---------------------------------------------------------------------------------------------| -> | `languages` | Array of IDs of all available languages | -> | `defaultLanguage` | ID of language that should be used when no locale could be determined | -> | `${IDs of languages}` | Each of the above listed languages needs a `LanguagePack` object like defined in [model.ts] | -> -> ### 2. Other JSON files -> -> The other JSON in [src/data] contain the user specific data. -> All languages that are configured in the previous step in [languages.json] need an entry in each of these files. -> For the definition of the obejcts to define refer to [model.ts]. -> - -## Development server +![example workflow](https://github.com/axherrm/CV/actions/workflows/continuous-deployment.yml/badge.svg) -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. - -## Build - -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. +This is the development project for the Curriculum Vitae of Axel Herrmann. +See the newest deployed version at https://axherrm.github.io/CV/. -[src/data]: src/data -[general.json]: src/data/general.json -[model.ts]: src/app/data/model.ts +The website was made available as [template](https://github.com/axherrm/WebCVTemplate) so that everyone can use it easily. +This repository can be seen as sample usage of the template.