UNPKG

gdscriptify

Version:

A magical documentation tool for GDScript.

github.com/hiulit/GDScriptify

hiulit/GDScriptify

71 lines (46 loc) • 2.24 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Generate a README file > ⚠️ GDScriptify will generate a `README` file if there's **only 1 GDScript file** in the Godot's project folder. GDScriptify will look at the **Applicaction/Config** section in **Projects Settings** to add: - Title - Description ![Project Settings](./../examples/project-settings.png) GDScriptify will look for some files to create some sections: - `LICENSE` - `CHANGELOG.md` ## Spice it up! Optionally, some fields can be added to the **Applicaction/Config** section in **Projects Settings** to make the `README` look better. ![Project Settings Optional](./../examples/project-settings-optional.png) ### Table of contents - [Badges](#badges) - [Sections](#sections) - [Author](#author) - [Contributing](#contributing) - [Support](#support) ### Badges The badges go right under the title. |Name|Description|Output| |:-|:-|:-| |`config/version`|The version of the project (e.g. `1.0.0`).|![Version badge](./../examples/badge-version.png)| |`config/godot_version`|The version of Godot the project supports (e.g `3.x`).|![Godot version badge](./../examples/badge-godot-version.png)| |`config/license`|The type of license of the project (e.g. `MIT`).|![License badge](./../examples/badge-license.png)| ### Banner The banner goes right after the description. |Name|Description|Output| |:-|:-|:-| |`config/banner`|The path to the image that will be used as a banner.|![Banner](./../gdscriptify-banner.jpg)| ### Sections #### Author |Name|Description|Output| |:-|:-|:-| |`config/author`|The author/s of the project. Multiple authors must be comma-separated. (e.g. `hiulit` or `hiulit, another person, etc.`)|![Author](./../examples/author.png)| #### Contributing |Name|Description|Output| |:-|:-|:-| |`config/repository`|The URL of the project's repository.|![Contributing](./../examples/contributing.png)| #### Support |Name|Description|Output| |:-|:-|:-| |`config/patreon`|The URL to Patreon.|![Patreon](./../examples/patreon.png)| |`config/ko-fi`|The URL to Ko-fi.|![Ko-fi](./../examples/ko-fi.png)| |`config/buy_me_a_coffee`|The URL to Buy Me a Coffee.|![Buy Me a Coffee](./../examples/buy_me_a_coffee.png)| |`config/paypal`|The URL to PayPal.|![Paypal](./../examples/paypal.png)|