Improve example

Author: arnaudgolfouse

.gitignore

@@ -1,4 +1,4 @@
 /target
-/example/*/target
+/examples/*/target
 Cargo.lock
 /fetch_godot_classes/godot

CONTRIBUTING.md

@@ -29,6 +29,6 @@ adjust/add tests accordingly.
 - ## Examples
 
     If your contribution changes the markdown/html/gut output, it would be 
-	good to update the example in `example/dijkstra-map-gd`.
+	good to update the example in `examples/dijkstra-map-gd`.
 
-	To do so, simply go to `example/dijkstra-map-gd` and run `cargo build`.
+	To do so, simply run `cargo build -p dijkstra-map-gd`.

Cargo.toml

@@ -9,9 +9,8 @@ edition = "2018"
 license = "MIT"
 
 [workspace]
-members = ["gdnative-doc-cli"]
+members = ["gdnative-doc-cli", "examples/dijkstra-map-gd"]
 default-members = [".", "gdnative-doc-cli"]
-exclude = ["example"]
 
 [dependencies]
 cargo_metadata = "0.12"

README.md

@@ -29,7 +29,7 @@ The goal of this tool is to automate writing documentation in Rust code that wil
  Output: gut |
  ![](assets/process-function-gut.png) |
 
-A more complete example can be found in the [example/dijkstra-map-gd](example/dijkstra-map-gd) directory.
+A more complete example can be found in the [examples/dijkstra-map-gd](examples/dijkstra-map-gd) directory.
 
 ## Usage
 

example/dijkstra-map-gd/Cargo.toml examples/dijkstra-map-gd/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "dijkstra_map_gd"
+name = "dijkstra-map-gd"
 version = "0.1.0"
 authors = ["Astrale", "Matej Sloboda"]
 edition = "2018"

example/dijkstra-map-gd/LICENSE examples/dijkstra-map-gd/LICENSE

@@ -1,10 +1,12 @@
 This example is based on https://github.com/MatejSloboda/Dijkstra_map_for_Godot.
 
 To generate the documentation, run either
-```
-cargo build
+```shell
+cargo build -p dijkstra-map-gd
 ```
 Or, if you have the gdnative-doc-cli executable
-```
+```shell
 gdnative-doc-cli -c config.toml --md doc/markdown --html doc/html --gut gut
-```
+```
+
+The resulting documentation can be found in the [doc](./doc) directory, and the gut tests in the [gut](./gut) directory.