Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dalexeev committed Jan 28, 2024
1 parent 9ca2c67 commit 092d96c
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

An export plugin for stripping comments and "conditional compilation" of GDScript.

Version: 1.0-dev. Compatible with Godot 4.2.x.
Version: **1.0-dev**. Compatible with Godot **4.2.x**. Status: should be ready
for production use. Please report if you find any bugs.

## How to use

Expand All @@ -11,15 +12,15 @@ Version: 1.0-dev. Compatible with Godot 4.2.x.
3. Export the project.

The original scripts will not be changed, but in PCK/ZIP the scripts will be changed.
Use ZIP to check the changes. If any errors occurred during the export, you will see them
in the Output Log.
Use ZIP to check to check the result. If any errors occurred during the export,
you will see them in the Output Log.

## Settings

You can change the settings in the Options tab of the Export dialog:

<details>
<summary>Screenshot<summary>
<summary>Screenshot</summary>

![image](screenshots/export_options.png)

Expand All @@ -44,10 +45,9 @@ You can specify a list of feature tags that will be treated as dynamic in the ex
* `Engine.is_editor_hint()`;
* `OS.is_debug_build()`;
* `OS.has_feature("feature_tag_name")`.
* Removing statements by regular expression.
* With default settings, `assert()`, `breakpoint`, `print_debug()`, and `print_stack()`
are removed in release builds.
* You can specify custom regexes in the export options.
* Removing statements by regular expression. With default settings, `assert()`, `breakpoint`,
`print_debug()`, and `print_stack()` are removed in release builds. Also, you can specify
custom regexes in the export options.

## Limitations

Expand All @@ -66,12 +66,14 @@ Original script:
```gdscript
extends Node
var a: int
#~if OS.has_feature("debug")
var b: int
#~endif
var c: int
## Comment.
func _ready() -> void:
# Comment.
Expand Down

0 comments on commit 092d96c

Please sign in to comment.