From 980b669898d8c83bef97bf5abca0ef62c3648dca Mon Sep 17 00:00:00 2001 From: olusegun0-creator Date: Wed, 27 Aug 2025 14:57:37 +0100 Subject: [PATCH 1/2] Create BUILD.md --- BUILD.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 BUILD.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..cb3c9fa --- /dev/null +++ b/BUILD.md @@ -0,0 +1,42 @@ +# Building Yail + +This document provides instructions on how to build the Yail library from the source. + +## Prerequisites + +Before you begin, ensure you have met the following requirements: + +- [Node.js](https://nodejs.org/en/): Use [nvm](https://github.com/nvm-sh/nvm) to + switch to the version specified in the [.nvmrc](./.nvmrc) file. To ensure + you're using the correct version of Node.js for this project, run `nvm use` in + the project directory. +- [pnpm](https://pnpm.io/): Install pnpm globally with `npm install -g pnpm`. + +## Setting Up the Development Environment + +### Clone the Repository + +First, clone the repository to your local machine: + +```bash +git clone https://github.com/Programmer-Network/yail.git +cd yail +``` + +### Install Dependencies + +Use `pnpm` to install all necessary dependencies: + +```bash +pnpm install +``` + +## Building for Production + +To build the library for production, run the following command: + +```bash +pnpm build +``` + +This will create a `dist` folder with the compiled code. From 76c111f5f49835f87c0f3361521aab2a76630fe0 Mon Sep 17 00:00:00 2001 From: olusegun0-creator Date: Wed, 27 Aug 2025 15:04:51 +0100 Subject: [PATCH 2/2] Update BUILD.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- BUILD.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/BUILD.md b/BUILD.md index cb3c9fa..06db320 100644 --- a/BUILD.md +++ b/BUILD.md @@ -40,3 +40,10 @@ pnpm build ``` This will create a `dist` folder with the compiled code. + +## Running Tests + +To run the test suite, use the following command: + +```bash +pnpm test