diff --git a/index.json b/index.json index 211187c..1de5fc2 100644 --- a/index.json +++ b/index.json @@ -722,7 +722,7 @@ "markdown/getting-started.html": { "href": "markdown/getting-started.html", "title": "Getting Started | RueI", - "keywords": "\nGetting Started\n\nthis guide assumes that you have a basic level of knowledge with c#.\nthere are three main ways of using RueI: as a \u0027hard\u0027 dependency, as a \u0027soft\u0027 dependency, or through reflection.\n\nwith a hard dependency, you directly reference RueI and use it in place of hints. the advantages of this are that it gives you type safety, it is significantly faster, and it is just overall much easier to use. however, if someone does not have RueI installed, then your plugin will stop working. this makes it ideal for plugins that rely on RueI heavily, or if you\u0027re creating a plugin for your own use.\na soft dependency still means that you reference RueI, but you also provide alternatives using normal hints and switch to those alternatives if RueI isn\u0027t detected, ideally using a dependency injection model. this requires you to carefully avoid type load exceptions, but doesn\u0027t have penalties to speed or type safety.\nusing reflection, you can dynamically add support for RueI, meaning that you don\u0027t have it reference it at all. reflection, however, is slow and does not provide any of the compile-time guarantees of the first two options, making it much harder to work with.\n\nthe way that you should use RueI depends on who your plugin is for and what it\u0027s doing. if you\u0027re making a private plugin or want to make use of all of the features of RueI, then you should make it a hard dependency. if your plugin is small and/or extensively uses hints, you should use it as a soft dependency. finally, if your plugin only uses hints occassionally, reflection is the best choice.\nthis guide will cover how to use RueI using the first option, as a normal hard dependency.\ninstalling RueI\n\n\u003C!--Getting Started this guide assumes that you have a basic level of knowledge with c#. there are three main ways of using RueI: as a \u0027hard\u0027 dependency, as a \u0027soft\u0027 dependency, or through reflection. with a hard dependency, you directly reference RueI and use it in place of hints. the advantages of this are that it gives you type safety, it is significantly faster, and it is just overall much easier to use. however, if someone does not have RueI installed, then your plugin will stop working. this makes it ideal for plugins that rely on RueI heavily, or if you\u0027re creating a plugin for your own use. a soft dependency still means that you reference RueI, but you also provide alternatives using normal hints and switch to those alternatives if RueI isn\u0027t detected, ideally using a dependency injection model. this requires you to carefully avoid type load exceptions, but doesn\u0027t have penalties to speed or type safety. using reflection, you can dynamically add support for RueI, meaning that you don\u0027t have it reference it at all. reflection, however, is slow and does not provide any of the compile-time guarantees of the first two options, making it much harder to work with. the way that you should use RueI depends on who your plugin is for and what it\u0027s doing. if you\u0027re making a private plugin or want to make use of all of the features of RueI, then you should make it a hard dependency. if your plugin is small and/or extensively uses hints, you should use it as a soft dependency. finally, if your plugin only uses hints occassionally, reflection is the best choice. this guide will cover how to use RueI using the first option, as a normal hard dependency. installing RueI--\u003E" + "keywords": "\nGetting Started\n\nthis guide assumes that you have a basic level of knowledge with c#.\nthere are three main ways of using RueI: as a \u0027hard\u0027 dependency, as a \u0027soft\u0027 dependency, or through reflection.\n\nwith a hard dependency, you directly reference RueI and use it in place of hints. the advantages of this are that it gives you type safety, it is significantly faster, and it is just overall much easier to use. however, if someone does not have RueI installed, then your plugin will stop working. this makes it ideal for plugins that rely on RueI heavily, or if you\u0027re creating a plugin for your own use.\na soft dependency still means that you reference RueI, but you also provide alternatives using normal hints and switch to those alternatives if RueI isn\u0027t detected, ideally using a dependency injection model. this requires you to carefully avoid type load exceptions, but doesn\u0027t have penalties to speed or type safety.\nusing reflection, you can dynamically add support for RueI, meaning that you don\u0027t have it reference it at all. reflection, however, is slow and does not provide any of the compile-time guarantees of the first two options, making it much harder to work with.\n\nthe way that you should use RueI depends on who your plugin is for and what it\u0027s doing. if you\u0027re making a private plugin or want to make use of all of the features of RueI, then you should make it a hard dependency. if your plugin is small and/or extensively uses hints, you should use it as a soft dependency. finally, if your plugin only uses hints occassionally, reflection is the best choice.\nthis guide will cover how to use RueI using the first option, as a normal hard dependency.\ninstalling RueI\nto install RueI as a dependency, you\u0027ll want to add it through nuget. this depends on which code editor you\u0027re using, but you can also install it through the command line. the nuget package for RueI is available here.\nafter you\u0027ve done that, make sure you put the RueI dll in your dependencies folder for the plugin manager you\u0027re using. you can get the latest release here.\nusing RueI\nusing RueI is pretty simple. you can import it using the using statement. make sure that in the method called when your plugin is loaded you call the RueIMain.EnsureInit function - this ensures everything is properly initialized for RueI.\n\n\u003C!--Getting Started this guide assumes that you have a basic level of knowledge with c#. there are three main ways of using RueI: as a \u0027hard\u0027 dependency, as a \u0027soft\u0027 dependency, or through reflection. with a hard dependency, you directly reference RueI and use it in place of hints. the advantages of this are that it gives you type safety, it is significantly faster, and it is just overall much easier to use. however, if someone does not have RueI installed, then your plugin will stop working. this makes it ideal for plugins that rely on RueI heavily, or if you\u0027re creating a plugin for your own use. a soft dependency still means that you reference RueI, but you also provide alternatives using normal hints and switch to those alternatives if RueI isn\u0027t detected, ideally using a dependency injection model. this requires you to carefully avoid type load exceptions, but doesn\u0027t have penalties to speed or type safety. using reflection, you can dynamically add support for RueI, meaning that you don\u0027t have it reference it at all. reflection, however, is slow and does not provide any of the compile-time guarantees of the first two options, making it much harder to work with. the way that you should use RueI depends on who your plugin is for and what it\u0027s doing. if you\u0027re making a private plugin or want to make use of all of the features of RueI, then you should make it a hard dependency. if your plugin is small and/or extensively uses hints, you should use it as a soft dependency. finally, if your plugin only uses hints occassionally, reflection is the best choice. this guide will cover how to use RueI using the first option, as a normal hard dependency. installing RueI to install RueI as a dependency, you\u0027ll want to add it through nuget. this depends on which code editor you\u0027re using, but you can also install it through the command line. the nuget package for RueI is available here. after you\u0027ve done that, make sure you put the RueI dll in your dependencies folder for the plugin manager you\u0027re using. you can get the latest release here. using RueI using RueI is pretty simple. you can import it using the using statement. make sure that in the method called when your plugin is loaded you call the RueIMain.EnsureInit function - this ensures everything is properly initialized for RueI.--\u003E" }, "markdown/hintbuilding.html": { "href": "markdown/hintbuilding.html", diff --git a/markdown/getting-started.html b/markdown/getting-started.html index 9e9617e..5dd5778 100644 --- a/markdown/getting-started.html +++ b/markdown/getting-started.html @@ -96,6 +96,10 @@

Getting Started

the way that you should use RueI depends on who your plugin is for and what it's doing. if you're making a private plugin or want to make use of all of the features of RueI, then you should make it a hard dependency. if your plugin is small and/or extensively uses hints, you should use it as a soft dependency. finally, if your plugin only uses hints occassionally, reflection is the best choice.

this guide will cover how to use RueI using the first option, as a normal hard dependency.

installing RueI

+

to install RueI as a dependency, you'll want to add it through nuget. this depends on which code editor you're using, but you can also install it through the command line. the nuget package for RueI is available here.

+

after you've done that, make sure you put the RueI dll in your dependencies folder for the plugin manager you're using. you can get the latest release here.

+

using RueI

+

using RueI is pretty simple. you can import it using the using statement. make sure that in the method called when your plugin is loaded you call the RueIMain.EnsureInit function - this ensures everything is properly initialized for RueI.