Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
axherrm committed Feb 4, 2024
1 parent 7b2d7c8 commit 6f178c0
Showing 1 changed file with 6 additions and 35 deletions.
41 changes: 6 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 6f178c0

Please sign in to comment.