From 01788405935a6fbed701b38bf3d60a8a12496e1d Mon Sep 17 00:00:00 2001
From: dylan <dylan@dlmw.ch>
Date: Wed, 29 Jan 2025 18:15:23 +0100
Subject: [PATCH] Update readme

---
 README.md                        | 50 ++++----------------------------
 src/gen/.openapi-generator/FILES |  1 -
 2 files changed, 5 insertions(+), 46 deletions(-)

diff --git a/README.md b/README.md
index bb22892..378c0c5 100644
--- a/README.md
+++ b/README.md
@@ -10,50 +10,10 @@ To start a local development server, run:
 ng serve
 ```
 
-Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
+## Generate code after API changes
 
-## Code scaffolding
+When the API is changed, the client source code must be regenerated.
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
-
-```bash
-ng generate component component-name
-```
-
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
-
-```bash
-ng generate --help
-```
-
-## Building
-
-To build the project run:
-
-```bash
-ng build
-```
-
-This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
-
-## Running unit tests
-
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
-
-```bash
-ng test
-```
-
-## Running end-to-end tests
-
-For end-to-end (e2e) testing, run:
-
-```bash
-ng e2e
-```
-
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
-
-## Additional Resources
-
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+1. Install the CLI `npm install -g @openapitools/openapi-generator-cli`
+1. Download the latest OpenAPI spec file from the API repository. **Please don't commit it!**
+1. Run `openapi-generator-cli generate -i [path_to_openapi.yml] -g typescript-angular -o src/gen/`. **Commit those changes**
diff --git a/src/gen/.openapi-generator/FILES b/src/gen/.openapi-generator/FILES
index 69f38c1..1b378a8 100644
--- a/src/gen/.openapi-generator/FILES
+++ b/src/gen/.openapi-generator/FILES
@@ -1,5 +1,4 @@
 .gitignore
-.openapi-generator-ignore
 README.md
 api.module.ts
 api/api.ts