From 08bc181afe487ef845e77fcb998268b4f8912f27 Mon Sep 17 00:00:00 2001 From: Mattk70 <61826357+Mattk70@users.noreply.github.com> Date: Sat, 27 Jan 2024 21:04:56 +0000 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 55ea8c34..66d210c2 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,11 @@ First, clone the project and install all dependencies: ``` git clone https://github.com/Mattk70/Chirpity-Electron cd Chirpity-Electron +``` + +Chirpity depends on Node.js, follow the link for the download and installation instructions. +Once installed, run: +``` npm install ``` @@ -24,21 +29,21 @@ npm start ## Development setup -Setting up the project requires Node.js, which we need to install first. -After that, we can initialize the source directory with: + +Initialize the source directory with: ``` npm init ``` -Now, we need to install project dependencoies with: +Now, install project dependencoies with: ``` npm install --save-dev ``` -After that, we can build a windows msi installer with: +After that, build a windows msi installer with: ``` npm run export