From e430d70c95d26fd68d70114068df80a01d31d5fe Mon Sep 17 00:00:00 2001 From: Jamie Jackson <15037@icf.com> Date: Thu, 13 Feb 2025 11:46:08 -0500 Subject: [PATCH] add some missing information to the hacking instructions --- readme.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index 0979fb9..a27a1fb 100644 --- a/readme.md +++ b/readme.md @@ -155,8 +155,27 @@ The code in this library has only been tested on Lucee and likely doesn't work o ## Extending this module/service -Individuals who would like to contribute to this library can follow the steps below to configure this tool to run independently for the purposes of extending and testing the code: - -1. This package currently depends on a `cfconfig.local` host entry. You can add this to your system's `hosts` file manually or leverage a tool like [Commandbox HostUpdater](https://www.forgebox.io/view/commandbox-hostupdater) to add the host entry. -2. Start up this project with CommandBox using `server start` - this will open a browser to the test runner for this project. -3. Happy Contributing! +Individuals who would like to contribute to this library can follow the steps below to configure this tool to run independently for the purposes of extending and testing the code. + +Happy contributing! + +### Prerequisites + + * This package depends on a `cfconfig.local` host entry. You can add this to your system's `hosts` file manually or leverage a tool like [Commandbox HostUpdater](https://www.forgebox.io/view/commandbox-hostupdater) to add the host entry. + * Manual + * Hosts File Location + * Windows: `C:\Windows\System32\drivers\etc\hosts` + * Mac/Linux: `/etc/hosts` + * Add the following line to the file: + ``` + 127.0.0.1 cfconfig.local + ``` + * Install [CommandBox](https://www.ortussolutions.com/products/commandbox) + * Install dependencies + ``` + box install + ``` + +### Run Tests + +Start up this project with CommandBox using `box server start` - this will open a browser to the test runner for this project.