Skip to content

Commit

Permalink
chore: update docs to match new repo (#207)
Browse files Browse the repository at this point in the history
* chore: update docs to match new repo

* chore: add mobile icon

* fix: issue with static checks
  • Loading branch information
nmerget authored Sep 21, 2024
1 parent f8b8e89 commit 2a96f31
Show file tree
Hide file tree
Showing 19 changed files with 82 additions and 686 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ body:
- Write a descriptive issue title above.
- The golden rule is to **always open *one* issue for *one* bug**. If you notice several bugs and want to report them, make sure to create one new issue for each of them.
- Search [open](https://github.com/godotengine/godot/issues) and [closed](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported. If you don't find a relevant match or if you're unsure, don't hesitate to **open a new issue**. The bugsquad will handle it from there if it's a duplicate.
- Verify that you are using a [supported Godot version](https://github.com/Geequlim/ECMAScript/releases). Please always check if your issue is reproducible in the latest version – it may already have been fixed!
- Verify that you are using a [supported Godot version](https://github.com/godotjs/javascript/releases). Please always check if your issue is reproducible in the latest version – it may already have been fixed!
- type: input
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

<!-- Describe the changes you've done -->

Make sure to follow the PR preparation steps in [CONTRIBUTING.md](https://github.com/Geequlim/ECMAScript/blob/master/CONTRIBUTING.md#preparing-your-pr) before submitting your PR:
Make sure to follow the PR preparation steps in [CONTRIBUTING.md](https://github.com/godotjs/javascript/blob/master/CONTRIBUTING.md#preparing-your-pr) before submitting your PR:

- [ ] format the codebase: from the root, run `bash ./clang_format.sh`.
28 changes: 0 additions & 28 deletions .github/workflows/gh_pages.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/static_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,6 @@ jobs:
if: github.event_name == 'pull_request' && env.CHANGED_FILES != ''
uses: codespell-project/actions-codespell@v2
with:
skip: "./bin,./thirdparty,*.desktop,*.gen.*,*.po,*.pot,*.rc,./AUTHORS.md,./COPYRIGHT.txt,./DONORS.md,./core/input/gamecontrollerdb.txt,./core/string/locales.h,./editor/project_converter_3_to_4.cpp,./misc/scripts/codespell.sh,./platform/android/java/lib/src/com,./platform/web/node_modules,./platform/web/package-lock.json"
skip: "./bin,./thirdparty,*.desktop,*.svg,*.gen.*,*.po,*.pot,*.rc,./AUTHORS.md,./COPYRIGHT.txt,./DONORS.md,./core/input/gamecontrollerdb.txt,./core/string/locales.h,./editor/project_converter_3_to_4.cpp,./misc/scripts/codespell.sh,./platform/android/java/lib/src/com,./platform/web/node_modules,./platform/web/package-lock.json"
ignore_words_list: "breaked,checkin,curvelinear,doubleclick,expct,findn,gird,hel,inout,labelin,lod,mis,nd,numer,ot,pointin,requestor,te,textin,thirdparty,vai"
path: ${{ env.CHANGED_FILES }}
9 changes: 1 addition & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@

TODO

## Documentation

This project uses [MKDocs](https://www.mkdocs.org/) to serve all docs. You can change the documentation inside the `docs` folder.
Install mkdocs via ``pip install mkdocs``.
Serve the docs via ``mkdocs serve``.
To add new pages you need to update `mkdocs.yml`.

## Preparing your PR

The project is using [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) to format most files. You need to run `bash ./clang_format.sh` before your PR for a successful pipeline.
Expand All @@ -20,7 +13,7 @@ Furthermore, there is an `utf-8` and `LF` checker to fix file formats. Additiona
## Release library

As a maintainer you are able to create a new release.
1. Go to [create new release](https://github.com/Geequlim/ECMAScript/releases/new)
1. Go to [create new release](https://github.com/godotjs/javascript/releases/new)
2. Next you should ``Choose a tag`` and create a new one in the format `v0.0.0`
3. Select target ``master``
4. Click ``Generate release notes``
Expand Down
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
# GodotJS - JavaScript language binding for Godot game engine
<picture>
<source media="(mmin-width: 720px)" srcset="docs/header.svg">
<img src="docs/header-mobile.svg" width="900" height="330" alt="GodotJS Logo">
</picture>

# **GodotJS**

***-- JavaScript and TypeScript language binding for Godot game engine --***

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


## Getting started

Read the [getting-started](https://godotjs.github.io/documentation/getting-started/).

## Features

- Almost complete ES2020 support
Expand All @@ -13,10 +25,6 @@ This module implements JavaScript/TypeScript language support for the Godot game
- Full code completion support for all Godot APIs including signals and enumerations
- Debug in Visual Studio Code with the [plugin](https://marketplace.visualstudio.com/items?itemName=geequlim.godot-javascript-debug) - currently not available for 4.x

### Getting started

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

## Getting the engine

No installation or setup necessary. The binaries for download are the complete, usable Godot editor and engine with JavaScript/TypeScript language support.
Expand All @@ -32,22 +40,23 @@ Download the binaries from the [release page](https://github.com/GodotExplorer/E
- `git clone https://github.com/godotengine/godot.git`
- This branch uses version `4.1` so checkout the version with: `git checkout 4.1`
- Clone this module and put it into `godot/modules/javascript`:
- `git clone [email protected]:Geequlim/ECMAScript.git godot/modules/javascript` or
- `git clone https://github.com/Geequlim/ECMAScript.git godot/modules/javascript`
- `git clone [email protected]:godotjs/javascript.git godot/modules/javascript` or
- `git clone https://github.com/godotjs/javascript.git godot/modules/javascript`
- [Recompile the godot engine](https://docs.godotengine.org/en/4.1/development/compiling/index.html)
- Use `scons` with those additional options `warnings=extra werror=yes module_text_server_fb_enabled=yes` to show all potential errors:
- Windows: `scons platform=windows warnings=extra werror=yes module_text_server_fb_enabled=yes`
- MacOS: `scons platform=macos arch=arm64 warnings=extra werror=yes module_text_server_fb_enabled=yes`

## Documentation, Tutorials & Demos

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

- [ECMAScriptDemos](https://github.com/Geequlim/ECMAScriptDemos) - Demos
Read this [documentation](https://godotjs.github.io/documentation/getting-started/) or look at the tutorials or demos:

- [ECMAScriptDemos](https://github.com/godotjs/javascriptDemos) - Demos
- [godot-ECMAScript-cookbook](https://github.com/why-try313/godot-ECMAScript-cookbook/wiki) - Tutorial
- [godot-typescript-starter](https://github.com/citizenll/godot-typescript-starter) - Template
- [godot-js-template](https://github.com/fukaraadam-workspace/godot-js-template) - Template

## Contributing

If you like to contribute to this project check the [CONTRIBUTING.md](https://github.com/Geequlim/ECMAScript/blob/master/CONTRIBUTING.md) file.
If you like to contribute to this project check the [CONTRIBUTING.md](https://github.com/godotjs/javascript/blob/master/CONTRIBUTING.md) file.
1 change: 1 addition & 0 deletions docs/JavaScript.svg.licence
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../icon/JavaScript.svg: https://commons.wikimedia.org/wiki/File:Unofficial_JavaScript_logo.svg
100 changes: 0 additions & 100 deletions docs/api.md

This file was deleted.

117 changes: 0 additions & 117 deletions docs/examples/load-json-in-singleton.md

This file was deleted.

Loading

0 comments on commit 2a96f31

Please sign in to comment.