relics added

2024-04-09 10:15:32 -05:00
parent 39157dded2
commit 6370bfaad7
43 changed files with 1639 additions and 10 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,60 @@
+
+### Localised READMEs
+ - [简体中文](READMECN.md) (Simplified Chinese)
+
+
+# TODO Manager
+
+![example_image](https://github.com/OrigamiDev-Pete/TODO_Manager/blob/main/addons/Todo_Manager/doc/images/example1.png)
+
+## Simple and flexible
+
+- Supports GDScript, C# and GDNative
+- Seamlessly integrated into the Godot dock
+- Lenient syntax. Write TODOs that suit your style
+- Quickly jump to lines and launch external editors
+
+## Customizable
+
+![settings_example](https://github.com/OrigamiDev-Pete/TODO_Manager/blob/main/addons/Todo_Manager/doc/images/example2.png)
+
+- Add your own RegEx patterns
+- Set colours to your liking
+
+## Installation
+
+### Method 1 (Godot Asset Library)
+
+The most simple way to get started using TODO Manager is to use Godot's inbuilt Asset Library to install the plugin into your project.
+
+#### Step 1
+
+Find TODO Manager in the Godot Asset Library.
+![AssetLib image](https://github.com/OrigamiDev-Pete/TODO_Manager/blob/main/addons/Todo_Manager/doc/images/Instruct1.png)
+
+#### Step 2
+
+Install the package. You may want to untick the /doc folder at this point as it is not necessary for the functions of the plugin.
+![Filestrcture image](https://github.com/OrigamiDev-Pete/TODO_Manager/blob/main/addons/Todo_Manager/doc/images/Instruct3.png)
+
+#### Step 4
+
+Enable the plugin in the project settings.
+![Project image](https://github.com/OrigamiDev-Pete/TODO_Manager/blob/main/addons/Todo_Manager/doc/images/Instruct4.png)
+
+### Method 2 (GitHub)
+
+#### Step 1
+
+Click Download ZIP from the 'Code' dropdown.
+![GitHub image](https://github.com/OrigamiDev-Pete/TODO_Manager/blob/main/addons/Todo_Manager/doc/images/Instruct5.png)
+
+#### Step 2
+
+- Unzip the file and add it into your project folder. Make sure 'addons' is a subdirectory of res://
+- DO NOT change the name of the 'addons' or 'Todo_Manager' folders as this will break the saving and loading of your settings.
+
+#### Step 3
+
+Enable the plugin in the project settings.
+![Project image](https://github.com/OrigamiDev-Pete/TODO_Manager/blob/main/addons/Todo_Manager/doc/images/Instruct4.png)