Website: improve docs about installation of code generators
Link to the official Java installer, as that doesn't require XCode to be installed (on macOS). And that works on Windows too.
This commit is contained in:
parent
65f391183e
commit
1b9b40728d
@ -19,6 +19,8 @@ There are three code generators used by Flamenco:
|
|||||||
[mockgen]: https://github.com/golang/mock/mockgen
|
[mockgen]: https://github.com/golang/mock/mockgen
|
||||||
[openapi-codegen]: https://openapi-generator.tech/
|
[openapi-codegen]: https://openapi-generator.tech/
|
||||||
|
|
||||||
|
### Go code generators
|
||||||
|
|
||||||
The first two generators can be installed with either of these commands:
|
The first two generators can be installed with either of these commands:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -29,9 +31,51 @@ $ go run mage.go installGenerators
|
|||||||
$ make install-generators
|
$ make install-generators
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Python and JavaScript code generators
|
||||||
|
|
||||||
|
|
||||||
`openapi-codegen` is bundled with the Flamenco sources, but does need a Java
|
`openapi-codegen` is bundled with the Flamenco sources, but does need a Java
|
||||||
runtime environment to be installed. On Ubuntu Linux, `sudo apt install
|
runtime environment to be installed.
|
||||||
default-jre-headless` should be enough.
|
|
||||||
|
{{< tabs "installing-java" >}}
|
||||||
|
{{< tab "Linux" >}}
|
||||||
|
|
||||||
|
On Ubuntu Linux this should be enough:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ sudo apt install default-jre-headless
|
||||||
|
```
|
||||||
|
|
||||||
|
Other Linux distributions very likely have a similar package.
|
||||||
|
|
||||||
|
{{< /tab >}}
|
||||||
|
{{< tab "Windows" >}}
|
||||||
|
|
||||||
|
Use the [official Java installer](https://www.java.com/en/download/manual.jsp).
|
||||||
|
|
||||||
|
{{< /tab >}}
|
||||||
|
{{< tab "macOS" >}}
|
||||||
|
|
||||||
|
**Option 1** (Native install)
|
||||||
|
|
||||||
|
Use the [official Java installer](https://www.java.com/en/download/manual.jsp).
|
||||||
|
|
||||||
|
<br />
|
||||||
|
|
||||||
|
**Option 2** (Homebrew)
|
||||||
|
|
||||||
|
Install Java via homebrew:
|
||||||
|
|
||||||
|
```
|
||||||
|
brew install java
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that this requires XCode to be installed.
|
||||||
|
|
||||||
|
{{< /tab >}}
|
||||||
|
{{< /tabs >}}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Committing Generated Code
|
## Committing Generated Code
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user