Skip to content

Commit 6f178c0

Browse files
committed
update README.md
1 parent 7b2d7c8 commit 6f178c0

File tree

1 file changed

+6
-35
lines changed

1 file changed

+6
-35
lines changed

README.md

+6-35
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,9 @@
1-
# CV - Axel Herrmann
1+
# CV - Axel Herrmann
22

3-
This is the development project for the Curriculum Vitae of Axel Herrmann.
4-
See the newest deployed version at https://axherrm.github.io/CV/
5-
6-
## How to fill the template
7-
8-
All data displayed on the CV is stored in [src/data].
9-
Use the following steps to insert your own data:
10-
> ### 1. [general.json]
11-
>
12-
> 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.
13-
> If all languages you want to use are defined you only need to adjust the languages array.
14-
>
15-
> | Field | Description |
16-
> |-----------------------|---------------------------------------------------------------------------------------------|
17-
> | `languages` | Array of IDs of all available languages |
18-
> | `defaultLanguage` | ID of language that should be used when no locale could be determined |
19-
> | `${IDs of languages}` | Each of the above listed languages needs a `LanguagePack` object like defined in [model.ts] |
20-
>
21-
> ### 2. Other JSON files
22-
>
23-
> The other JSON in [src/data] contain the user specific data.
24-
> All languages that are configured in the previous step in [languages.json] need an entry in each of these files.
25-
> For the definition of the obejcts to define refer to [model.ts].
26-
>
27-
28-
## Development server
3+
![example workflow](https://github.com/axherrm/CV/actions/workflows/continuous-deployment.yml/badge.svg)
294

30-
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.
31-
32-
## Build
33-
34-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
5+
This is the development project for the Curriculum Vitae of Axel Herrmann.
6+
See the newest deployed version at https://axherrm.github.io/CV/.
357

36-
[src/data]: src/data
37-
[general.json]: src/data/general.json
38-
[model.ts]: src/app/data/model.ts
8+
The website was made available as [template](https://github.com/axherrm/WebCVTemplate) so that everyone can use it easily.
9+
This repository can be seen as sample usage of the template.

0 commit comments

Comments
 (0)