From e4130518e121d62abb058995fd1ac276d6f55281 Mon Sep 17 00:00:00 2001 From: duckietm Date: Thu, 25 Apr 2024 16:47:29 +0200 Subject: [PATCH] update ReadMe --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7b6ffc1..3657c04 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Nitro React v2.1 +# v2.2.0 - Cool UI Beta !! Use at Own Risk as it is still in Beta !! ## Prerequisites @@ -9,12 +9,16 @@ ## Installation -- First you should open terminal and navigate to the folder where you want to clone Nitro -- Clone Nitro - - `git clone https://git.krews.org/nitro/nitro-react.git` -- Install the dependencies +- First you should open terminal and navigate to the folder where you want to clone Nitro and Nitro-Renderer +- Clone Nitro (Expl. C:\Github\) + - `git clone https://github.com/duckietm/Nitro-Cool-UI.git` <== For now switch to Dev-RendererV2 + - `git clone https://github.com/duckietm/Nitro-Cool-UI-Renderer.git` + - Install the dependencies for the renderer : cd C:\Github\Nitro-Cool-UI-Renderer - `yarn install` - - This may take some time, please be patient + - Now we will create a Link for the CoolUI : `yarn link` This will give you a link address `yarn link "@nitrots/nitro-renderer"` + - Install the dependencies for Cool UI : cd C:\Github\Nitro-Cool-UI + - `yarn install` + - `yarn "@nitrots/nitro-renderer` <== This will link the renderer in the project - Rename a few files - Rename `public/renderer-config.json.example` to `public/renderer-config.json` - Rename `public/ui-config.json.example` to `public/ui-config.json` @@ -23,6 +27,7 @@ - Update `socket.url, asset.url, image.library.url, & hof.furni.url` - Open `public/ui-config.json` - Update `camera.url, thumbnails.url, url.prefix, habbopages.url` + - `yarn build` <== the final step to build the DIST folder this is where your browser needs to point / or upload this to your /client if you do the compile on a other machine (preferd) - You can override any variable by passing it to `NitroConfig` in the index.html ## Usage @@ -47,4 +52,4 @@ yarn build:prod ``` - A `dist` folder will be generated, these are the files that must be uploaded to your webserver -- Consult your CMS documentation for compatibility with Nitro and how to add the production files +- Consult your CMS documentation for compatibility with Nitro and how to add the production files \ No newline at end of file