Skip to content

Commit 6745ac0

Browse files
authored
docs: add correct godot version for "Compiling from source" (#188)
1 parent 74cb41c commit 6745ac0

File tree

2 files changed

+32
-22
lines changed

2 files changed

+32
-22
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GodotJS - JavaScript language binding for Godot game engine
1+
# GodotJS - JavaScript language binding for Godot game engine
22

33
This module implements JavaScript/TypeScript language support for the Godot game engine using [QuickJS](https://bellard.org/quickjs/) as the JavaScript engine.
44

@@ -22,23 +22,28 @@ Read the [getting-started](https://geequlim.github.io/ECMAScript/getting-started
2222
No installation or setup necessary. The binaries for download are the complete, usable Godot editor and engine with JavaScript/TypeScript language support.
2323

2424
### Binary downloads
25+
2526
Download the binaries from the [release page](https://github.com/GodotExplorer/ECMAScript/releases).
2627

2728
### Compiling from source
28-
- Clone the source code of [godot](https://github.com/godotengine/godot):
29-
- ``git clone [email protected]:godotengine/godot.git`` or
30-
- ``git clone https://github.com/godotengine/godot.git``
31-
- Clone this module and put it into `godot/modules/javascript`:
32-
- ``git clone [email protected]:Geequlim/ECMAScript.git godot/modules/javascript`` or
33-
- ``git clone https://github.com/Geequlim/ECMAScript.git godot/modules/javascript``
34-
- [Recompile the godot engine](https://docs.godotengine.org/en/4.1/development/compiling/index.html)
35-
- Use ``scons`` with those additional options ``warnings=extra werror=yes module_text_server_fb_enabled=yes`` to show all potential errors
29+
30+
- Clone the source code of [godot](https://github.com/godotengine/godot):
31+
- `git clone [email protected]:godotengine/godot.git` or
32+
- `git clone https://github.com/godotengine/godot.git`
33+
- This branch uses version `4.1` so checkout the version with: `git checkout 4.1`
34+
- Clone this module and put it into `godot/modules/javascript`:
35+
- `git clone [email protected]:Geequlim/ECMAScript.git godot/modules/javascript` or
36+
- `git clone https://github.com/Geequlim/ECMAScript.git godot/modules/javascript`
37+
- [Recompile the godot engine](https://docs.godotengine.org/en/4.1/development/compiling/index.html)
38+
- Use `scons` with those additional options `warnings=extra werror=yes module_text_server_fb_enabled=yes` to show all potential errors:
39+
- Windows: `scons platform=windows warnings=extra werror=yes module_text_server_fb_enabled=yes`
40+
- MacOS: `scons platform=macos arch=arm64 warnings=extra werror=yes module_text_server_fb_enabled=yes`
3641

3742
## Documentation, Tutorials & Demos
3843

3944
Read this [documentation](https://geequlim.github.io/ECMAScript/getting-started) or look at the tutorials or demos:
4045

41-
4246
- [ECMAScriptDemos](https://github.com/Geequlim/ECMAScriptDemos) - Demos
4347
- [godot-ECMAScript-cookbook](https://github.com/why-try313/godot-ECMAScript-cookbook/wiki) - Tutorial
4448
- [godot-typescript-starter](https://github.com/citizenll/godot-typescript-starter) - Template
49+
- [godot-js-template](https://github.com/fukaraadam-workspace/godot-js-template) - Template

docs/index.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GodotJS - JavaScript language binding for Godot game engine
1+
# GodotJS - JavaScript language binding for Godot game engine
22

33
This module implements JavaScript/TypeScript language support for the Godot game engine using [QuickJS](https://bellard.org/quickjs/) as the JavaScript engine.
44

@@ -15,30 +15,35 @@ This module implements JavaScript/TypeScript language support for the Godot game
1515

1616
### Getting started
1717

18-
Read the [getting-started](https://geequlim.github.io/ecmascript/getting-started).
18+
Read the [getting-started](https://geequlim.github.io/ECMAScript/getting-started).
1919

2020
## Getting the engine
2121

2222
No installation or setup necessary. The binaries for download are the complete, usable Godot editor and engine with JavaScript/TypeScript language support.
2323

2424
### Binary downloads
25+
2526
Download the binaries from the [release page](https://github.com/GodotExplorer/ECMAScript/releases).
2627

2728
### Compiling from source
29+
2830
- Clone the source code of [godot](https://github.com/godotengine/godot):
29-
- ``git clone [email protected]:godotengine/godot.git`` or
30-
- ``git clone https://github.com/godotengine/godot.git``
31+
- `git clone [email protected]:godotengine/godot.git` or
32+
- `git clone https://github.com/godotengine/godot.git`
33+
- This branch uses version `4.1` so checkout the version with: `git checkout 4.1`
3134
- Clone this module and put it into `godot/modules/javascript`:
32-
- ``git clone [email protected]:Geequlim/ECMAScript.git godot/modules/javascript`` or
33-
- ``git clone https://github.com/Geequlim/ECMAScript.git godot/modules/javascript``
35+
- `git clone [email protected]:Geequlim/ECMAScript.git godot/modules/javascript` or
36+
- `git clone https://github.com/Geequlim/ECMAScript.git godot/modules/javascript`
3437
- [Recompile the godot engine](https://docs.godotengine.org/en/4.1/development/compiling/index.html)
35-
- Use ``scons`` with those additional options ``warnings=extra werror=yes module_text_server_fb_enabled=yes`` to show all potential errors
38+
- Use `scons` with those additional options `warnings=extra werror=yes module_text_server_fb_enabled=yes` to show all potential errors:
39+
- Windows: `scons platform=windows warnings=extra werror=yes module_text_server_fb_enabled=yes`
40+
- MacOS: `scons platform=macos arch=arm64 warnings=extra werror=yes module_text_server_fb_enabled=yes`
3641

3742
## Documentation, Tutorials & Demos
3843

39-
Read this [documentation](https://geequlim.github.io/ecmascript/) or look at the tutorials or demos:
40-
44+
Read this [documentation](https://geequlim.github.io/ECMAScript/getting-started) or look at the tutorials or demos:
4145

42-
- [ECMAScriptDemos](https://github.com/Geequlim/ECMAScriptDemos)
43-
- [godot-ECMAScript-cookbook](https://github.com/why-try313/godot-ECMAScript-cookbook/wiki)
44-
- [godot-typescript-starter](https://github.com/citizenll/godot-typescript-starter)
46+
- [ECMAScriptDemos](https://github.com/Geequlim/ECMAScriptDemos) - Demos
47+
- [godot-ECMAScript-cookbook](https://github.com/why-try313/godot-ECMAScript-cookbook/wiki) - Tutorial
48+
- [godot-typescript-starter](https://github.com/citizenll/godot-typescript-starter) - Template
49+
- [godot-js-template](https://github.com/fukaraadam-workspace/godot-js-template) - Template

0 commit comments

Comments
 (0)