Skip to content

Commit 2365d7a

Browse files
committed
Edited the README to match other READMEs
1 parent 4dae29c commit 2365d7a

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

gdscript/README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,39 @@
22

33
# GDScript Explorations:
44

5-
To begin coding with GDScript, start by installing the [Godot Engine](https://godotengine.org/) to be able to write in GDScript. Another way to install Godot can be done [here](https://www.francogarcia.com/en/blog/development-environments-gdscript/#interpreter-and-text-editor).
5+
To build and run GDScript programs on your local machine, download and install the most recent game engine version from the [Godot downloads page](https://godotengine.org/) or use your favorite package manager.
66

7-
If you are on Windows and want to install Godot via the command line, type in the following command in Windows Powershell through the Administrator role (you will need to install [Chocolatey](https://chocolatey.org/install) if you have not yet done so already):
7+
Programs in this folder can be run from the command line like so:
88

99
```
10-
choco install godot
10+
godot -s triple.gd
1111
```
1212

13-
To run a gdscript like hello_world.gd, run the following command:
13+
```
14+
godot -s permutations.gd I like carrots
15+
```
1416

1517
```
16-
godot --display-driver headless --no-header -s hello_world.gd
18+
godot -s top_ten_scorers.gd < ../test/wnba_input
19+
```
20+
21+
Running the command `godot` with at any time will open the Godot game engine. To avoid this, add the flag `--display-driver headless`.
22+
23+
To make sure that your test matches properly to the test files, you will need to add the `--no-header` flag.
24+
25+
The test files will have this command ran. It is quite verbose, but it allows you to run GDScript programs without any inconveniences.
26+
1727
```
28+
godot --display-driver headless --no-header -s triple.gd
29+
```
30+
31+
To run the tests on a Unix-like shell:
32+
33+
```
34+
./test.sh
35+
```
36+
37+
Run `test.ps1` in PowerShell.
1838

1939
If you are unable to install Godot on your computer, then you can write on the online third-party
2040
[GDScript Playground](https://gd.tumeo.space/#).

0 commit comments

Comments
 (0)