From 92136a0ac73ce6a9897d577c4482309175453338 Mon Sep 17 00:00:00 2001
From: Kuuuube <61125188+Kuuuube@users.noreply.github.com>
Date: Fri, 22 Nov 2024 19:32:29 -0500
Subject: [PATCH] Add build instructions to readme (#1597)

* Add build instructions to readme

* Add build option that includes version number

* Add license report to build steps
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 480bcd032..38e1b1e09 100644
--- a/README.md
+++ b/README.md
@@ -96,6 +96,20 @@ If you want to add or improve support for a language, read the documentation on
 
 Feel free to join us on the [Yomitan Discord](https://discord.gg/YkQrXW6TXF).
 
+## Building Yomitan
+
+1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/).
+
+2. Run `npm ci` to set up the environment.
+
+3. Run `npm run license-report:html` to generate any missing or changed license information.
+
+4. Run `npm run build` for a plain testing build or `npm run-script build -- --all --version {version}` for a release build (replacing `{version}` with a version number).
+
+5. The builds for each browser and release branch can be found in the `builds` directory.
+
+For more information, see [Contributing](./CONTRIBUTING.md#setup).
+
 ## Third-Party Libraries
 
 Yomitan uses several third-party libraries to function.