Skip to content

Commit 76bddac

Browse files
committed
Update README.md
1 parent 0ddd8e6 commit 76bddac

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Please edit this file as it is the primary description file for your project. Yo
1818

1919
# OpenUI5 TypeScript Walkthrough
2020

21-
In this tutorial we'll introduce you to all major development paradigms of OpenUI5. We'll demonstrate the use of TypeScript with OpenUI5 and highlight the specific characteristics of this approach.
21+
In this tutorial we'll introduce you to all major development paradigms of OpenUI5. <details class="ts-only" markdown="1"><summary>This section is relevant for TypeScript only</summary>We'll also demonstrate the use of TypeScript with OpenUI5 and highlight the specific characteristics of this approach.</details>
2222

2323
## Description
2424

@@ -80,13 +80,15 @@ The tutorial consists of the following steps. To start, just open the first link
8080

8181
## Requirements
8282

83-
The project uses npm workspaces and requires a [Node.js](https://nodejs.org/) version >= `20.11.0` to be installed.
83+
Running the content of this repository locally (as opposed to following the tutorial steps) requires a [Node.js](https://nodejs.org/) version >= `20.11.0` to be installed.
8484

85-
### Getting Started
85+
## Download and Installation
86+
87+
> This section describes how to run the content of the repository locally and is *not* required for following the tutorial. For following the tutorial, simply start with Step 1 in the list of steps above. From there, you can also download and run the result of each step locally.
8688
87-
The project is setup as monorepo. All steps are located inside the `steps` folder and labelled with their step number. The monorepo uses `npm` workspaces to manage all steps together. But you can also run `npm` inside each individual step.
89+
The project is set up as monorepo. All steps are located inside the `steps` folder and labelled with their step number. The monorepo uses `npm` workspaces to manage all steps together. But you can also run `npm` inside each individual step.
8890

89-
To setup the monorepo you first need to install all depenedencies:
91+
To set up the monorepo you first need to install all depenedencies:
9092

9193
```sh
9294
npm install
@@ -103,15 +105,6 @@ cd steps/01
103105
npm start
104106
```
105107

106-
## Download and Installation
107-
108-
<!--
109-
TODO
110-
111-
* create GitHub pages to showcase the built examples
112-
* create ZIP files for each step which can be downloaded
113-
-->
114-
115108
## Known Issues
116109

117110
No known issues.
@@ -128,4 +121,4 @@ If you wish to contribute code, offer fixes or improvements, please send a pull
128121

129122
## License
130123

131-
Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file.
124+
Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file.

README_AUTHORS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,15 @@ To immediately preview the markdown document you are writing *including* the two
2424
npm i
2525
```
2626

27-
in the root folder of this project once for the setup, then to actually run the server, run
27+
in the root folder of this project once for the setup.
28+
29+
Then, to actually start the server, run
2830

2931
```sh
3032
npm start
3133
```
3234

33-
Then, open http://localhost:1337/README.md in your browser and the browser will automatically open (on port 3000 or the next free port) and automatically reload on every saved change.
35+
A browser window will automatically open (on port 3000 or the next free port) and automatically reload on every saved change.
3436

3537

3638
## Writing *one* document which covers both JavaScript and TypeScript without duplication

0 commit comments

Comments
 (0)