From fb2b9e943f18ec825b0c3c31749ea2bbc19e573a Mon Sep 17 00:00:00 2001 From: kuuuube Date: Fri, 22 Nov 2024 11:25:46 -0500 Subject: [PATCH 1/3] Add build instructions to readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 480bcd032..baec22778 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. From 230a19f79a898edba8971d026d183c0eb8905087 Mon Sep 17 00:00:00 2001 From: kuuuube Date: Fri, 22 Nov 2024 11:38:21 -0500 Subject: [PATCH 2/3] Add build option that includes version number --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index baec22778..17dfc7ec8 100644 --- a/README.md +++ b/README.md @@ -100,9 +100,11 @@ Feel free to join us on the [Yomitan Discord](https://discord.gg/YkQrXW6TXF). 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/). -2. Run `npm ci` and `npm run build`. +2. Run `npm ci` to set up the environment. -3. The builds for each browser and release branch can be found in the `builds` directory. +3. 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). + +4. The builds for each browser and release branch can be found in the `builds` directory. For more information, see [Contributing](./CONTRIBUTING.md#setup). From 71d81d309a81a77bcb9e0f2acb8356c269f462d5 Mon Sep 17 00:00:00 2001 From: kuuuube Date: Fri, 22 Nov 2024 11:43:25 -0500 Subject: [PATCH 3/3] Add license report to build steps --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 17dfc7ec8..38e1b1e09 100644 --- a/README.md +++ b/README.md @@ -102,9 +102,11 @@ Feel free to join us on the [Yomitan Discord](https://discord.gg/YkQrXW6TXF). 2. Run `npm ci` to set up the environment. -3. 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). +3. Run `npm run license-report:html` to generate any missing or changed license information. -4. The builds for each browser and release branch can be found in the `builds` directory. +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).