From fb2b9e943f18ec825b0c3c31749ea2bbc19e573a Mon Sep 17 00:00:00 2001 From: kuuuube Date: Fri, 22 Nov 2024 11:25:46 -0500 Subject: [PATCH] Add build instructions to readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 480bcd032b..baec227782 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,16 @@ 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` and `npm run build`. + +3. 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.