From fd709ba2e1738379eb3ad460341a40cd1152cfc9 Mon Sep 17 00:00:00 2001 From: Neil Dorin Date: Tue, 25 Aug 2020 15:00:24 -0600 Subject: [PATCH] Updates Readme.md to include dependency instructions for nuget package management --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 4cc9045..110e184 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,21 @@ Provided under MIT license ## Overview Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://github.com/PepperDash/Essentials/wiki/Plugins) article. + +## Cloning Instructions + +After using a fork of this repo as a template to create a new repository, you must install the necessary dependencies: + +## Dependencies + +The [Essentials](https://github.com/PepperDash/Essentials) libraries are required. They referenced via nuget. You must have nuget.exe installed and in the `PATH` environment variable to use the following command. Nuget.exe is available at [nuget.org](https://dist.nuget.org/win-x86-commandline/latest/nuget.exe). + +### Installing Dependencies + +To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository: +`nuget install .\packages.config -OutputDirectory .\packages -excludeVersion`. +To verify that the packages installed correctly, open Essentials and make sure that all references are found, then try and build it. + +### Installing Different versions of PepperDash Core + +If you need a different version of PepperDash Core, use the command `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}`. Omitting the `-Version` option will pull the version indicated in the packages.config file.