Skip to content

Commit

Permalink
doc: add a simple README
Browse files Browse the repository at this point in the history
  • Loading branch information
fmorgner committed Aug 1, 2020
1 parent 0178a23 commit c064bb8
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/build
/pkg
/pkg
/*.tzst
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION "3.17.0")
cmake_minimum_required(VERSION "3.14.0")

project("dodgetc_native"
LANGUAGES CXX
Expand Down
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Dodge the Creeps!

This is an implementation of the Godot "Dodge the Creeps!" tutorial game using godot-cpp 3.2.

## Running the packaged version

After downloading and extracting the package, you will most likely need to mark the `Dodge the Creeps!.x86_64` file, located in the folder `Dodge the Creeps! (Linux 64)` as executable.
Afterwards, simply launch the executable file.

## Compiling

Before you can use the "script" implementations in Godot, you will need to compile the shared library.
You will need the following:

* Conan
* CMake >= 3.14
* GCC >= 9.2

If you have installed the required tools, issue the following commands from the root folder of your clone:

```
$ cmake -S . -B build
$ cmake --build build
```

If the compilation succeeds, you can now open the project in the Godot editor.

## Packaging

To export the Godot project, simply issue the following commands from the root folder of your clone:

```
mkdir -p pkg
godot --path godot --export "Linux" '../pkg/Dodge the Creeps!.x86_64'
```

You will be left with an executable and the "script" library.
To further bundle them, use the following command from the root folder of your clone:

```
tar -czf 'Dodge the Creeps! (Linux 64).tzst' --transform 's/pkg/Dodge the Creeps! (Linux 64)/' pkg/*
```

0 comments on commit c064bb8

Please sign in to comment.