Skip to content

Commit c598116

Browse files
committed
cleanup, slim down install notes
1 parent 9a9a303 commit c598116

File tree

6 files changed

+10
-102
lines changed

6 files changed

+10
-102
lines changed

_doc/showcase/libshowcase.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

_doc/showcase/mapshowcase.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

_doc/start.md

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Installation
33
excerpt: Install WurstScript and setup your first project.
4-
date: 2023-11-16
4+
date: 2024-02-08
55
icon:
66
type: fa
77
name: fa-paper-plane
@@ -15,73 +15,38 @@ In this guide we will show you how to install WurstScript and set up your first
1515

1616
WurstScript and its related tools require Java 11+ to run. Editor support is provided via a VSCode extension.
1717

18-
### Download JRE
18+
### Java
1919

2020
[_ _{: .fa .fa-download} Download Java from Adoptium](https://adoptium.net/?variant=openjdk11){: .btn .btn-orange}
2121

2222
Download the Java Runtime appropriate for your system and follow the installation procedure.
2323

24-
Once finished, continue to the next step.
24+
### VSCode
2525

26-
### Verify Java Installation
27-
28-
Many tasks rely on a environment variable called **JAVA_HOME** which might not have been set by the installer.
29-
To verify your installation, open a command prompt and enter `java -version`.
30-
31-
A valid installation will return something like this:
32-
33-
```powershell
34-
> java -version
35-
openjdk version "11.0.17" 2022-10-18
36-
OpenJDK Runtime Environment Temurin-11.0.17+8 (build 11.0.17+8)
37-
OpenJDK 64-Bit Server VM Temurin-11.0.17+8 (build 11.0.17+8, mixed mode)
38-
```
39-
40-
The major version should be `11` or higher. If it is lower, you must update your Java installation.
41-
42-
If you get an error or get a lower versions displayed, even though you installed a newer one, your **JAVA_HOME** is either missing or configured wrong.
43-
44-
Refer to this [_ _{: .fa .fa-external-link-square} Windows tutorial](https://confluence.atlassian.com/doc/setting-the-java_home-variable-in-windows-8895.html) in order to setup your **JAVA_HOME** correctly.
45-
46-
Once you have setup Java correctly, continue by installing VSCode.
26+
[_ _{: .fa .fa-download} Download VSCode](https://code.visualstudio.com/){: .btn .btn-primary}
4727

4828
## Install Wurstscript
4929

5030
Now we will setup a Wurst compiler environment and create a project using the the WurstSetup, also known as `grill`.
5131

5232
[_ _{: .fa .fa-download} Download WurstSetup](https://grill.wurstlang.org/hudson/job/WurstSetup/lastSuccessfulBuild/artifact/downloads/WurstSetup.jar){: .btn .btn-green}
5333

54-
The Wurstsetup can be used either from the commandline or as a graphical application.
55-
56-
## Commandline
57-
58-
Usage by invoking `grill` via the commandline is recommended and provides a similar user experience to tools such as `npm`, `maven`. etc. To use the setup from the commandline you need to complete the initial installation once.
59-
After that you can invoke `grill` from your commandline.
60-
61-
### Initial installation
62-
63-
For the first time you have to run the .jar file directly, because the executable hasn't been installed yet.
64-
65-
`java -jar WurstSetup.jar install wurstscript`
66-
67-
Now you need to add the `~/.wurst` folder to your PATH environment variable, so you can use it from the commandline.
68-
Refer to this [tutorial](https://www.java.com/en/download/help/path.xml). On Windows 10, the result should look like this:
69-
70-
![](https://i.imgur.com/8bFJJVT.jpg){: .img-responsive}
34+
Download WurstSetup and perform installation by running `java -jar WurstSetup.jar install wurstscript` or double-clicking to start the graphical user interface.
7135

72-
The `grill` command should now be recognized by your terminal of choice.
36+
Now you need to add the `~/.wurst` folder to your PATH environment variable, so that `grill` is recognized from the commandline.
37+
Refer to this [tutorial](https://www.java.com/en/download/help/path.xml).
7338

74-
![](https://i.imgur.com/FNSBYgD.jpg){: .img-responsive}
39+
## Commandline Usage
7540

76-
If not, a restart might be required.
41+
Using `grill` from the commandline you can now start with generating a new project or installing an existing project. The user experience is similar to tools such as `npm`, `mvn`. etc.
7742

7843
### Updating the Compiler
7944

8045
Use the special `wurstscript` keyword to install or update wurst on your system for the current user.
8146

8247
`grill install wurstscript`
8348

84-
### Create a Wurst Project
49+
### Create a new Wurst Project
8550

8651
Use `generate` to create new projects. The project will be generated in a folder inside your current location with the name provided.
8752

@@ -117,4 +82,3 @@ To add a new dependency, run the `install` command with a second parameter that
11782

11883
By running the `WurstSetup.jar` without any arguments or simply by double-clicking, you can alternatively use the deprecated, graphical user interface.
11984

120-
![](/assets/images/setup/WurstSetup.png){: .img-responsive}

_doc/start/install_vscode.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

_doc/start/install_wurst.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

_doc/start/prerequisites.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)