Skip to content

Commit

Permalink
Update READMEs to use GitHub admonition syntax, use --import CLI ar…
Browse files Browse the repository at this point in the history
…gument
  • Loading branch information
Calinou committed Jul 16, 2024
1 parent ed0d1f6 commit 375cec3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Thank you for your interest in contributing!

> **Note**
> [!NOTE]
>
> This project only supports Godot's `master` branch (4.0's development branch),
> not Godot 3.x.
> This project only supports Godot's `master` branch (4.x's development branch),
> not Godot 3.x.
> Attempting to open this project in Godot 3.x will result in errors.
## Adding new benchmarks
Expand Down Expand Up @@ -59,7 +59,9 @@ Remember to follow the
when writing new scripts. Adding type hints is recommended whenever possible,
unless you are specifically benchmarking non-typed scripts.

> C# benchmark functions must begin with `Benchmark`, instead of `benchmark_`.
> [!NOTE]
>
> C# benchmark functions must begin with `Benchmark`, instead of `benchmark_`.
> For C# benchmarks to be available, you must use the .NET version of the engine.
### Test the benchmark
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,14 @@ The results JSON is printed to standard output once all benchmarks are run.
You can save the results JSON to a file using `--save-json="path/to/file.json"`
(the target folder **must** exist).

> **Note**
> [!TIP]
>
> To import the project in the editor from the command line, use `godot --editor --quit`.
> If this doesn't work, use `timeout 30 godot --editor`.
> To import the project in the editor from the command line, use `godot --import`.
> **Note**
> [!NOTE]
>
> `godot` is assumed to be in your `PATH` environment variable here. If this is
> not the case, replace `godot` with the absolute path to your Godot editor or export template
> binary.
> not the case, replace `godot` with the absolute path to your Godot editor or export template binary.
#### Run all benchmarks

Expand Down

0 comments on commit 375cec3

Please sign in to comment.