Add Setup instructions

[konnraad]

discussed with @flovogt

[cla-assistant]

All committers have signed the CLA.

[cla-assistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[flovogt]

@matz3 and @RandomByte, should we promote global installation or should we try to use npx in this case? In the UI5 Tooling documentation https://sap.github.io/ui5-tooling/v4/pages/GettingStarted/ we recommend global installation but i guess at that point in time npx was not yet available.

[matz3]

It would need to be npx @ui5/cli init (https://www.npmjs.com/package/@ui5/cli), right? There's no package named ui5, as it is a scope.

[flovogt]

true

[flovogt]

@konnraad feel free to adjust the PR

[matz3]

Well, I think I missed some detail. npx ui5 works fine, if you have the @ui5/cli package installed in your project. Which is the case in this scenario. But IMO this leads to a lot of confusion (as it already confused me).

npm exec ui5 would be the correct and safe way of invoking the local ui5 binary in a package. This way you don't accidentally try to install the ui5 package. But again, this is then also longer to type.

And our global ui5 CLI invokes the local installation, so there's no downside of having a global and local installation.

[konnraad]

I think a better solution would be to install it as a dev dependency and also globally.
I've tested on my device, and it worked for me.
(I've updated my initial PR)

It would look like this:

npm install -D -g @ui5/cli

[matz3]

@matz3 and @RandomByte, should we promote global installation or should we try to use npx in this case? In the UI5 Tooling documentation https://sap.github.io/ui5-tooling/v4/pages/GettingStarted/ we recommend global installation but i guess at that point in time npx was not yet available.

Typically the command is used more than just once. Therefore, I would still expect that one global install is more user-friendly than having to use npx @ui5/cli something instead of ui5 something every time.
But of course, both are valid.

[sap-doc-bot]

Thank you for your valuable content contribution, @konnraad! So that we can recognize your contribution in the SAP Community, please check your SAP Community user ID (this is a number) in your personal settings page and share it with us in a reply to this comment. Make sure you just include the number in the reply.

Your user ID is displayed as follows:

Change display name for User ID N

where N is your user ID. For example, 53 is the user ID of the user 'qmacro'.

Please note that we are currently refactoring our profile and badge system on the SAP Community, and will start assigning badges again when that's complete.

[KlattG]

Implemented from 1.127