Skip to content

Commit c048498

Browse files
committed
Add build instructions to readme
* Add build instructions to readme * Add build option that includes version number * Add license report to build steps <rikaitan.link>OTIxMzZhMGFjNzNjZTZhOTg5N2Q1NzdjNDQ4MjMwOTE3NTQ1MzMzOAo=</rikaitan.link>
1 parent ae1e767 commit c048498

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,20 @@ If you want to add or improve support for a language, read the documentation on
145145

146146
Feel free to join us on [DJT 🍔](https://tatsumoto.neocities.org/blog/join-our-community).
147147

148+
## Building Rikaitan
149+
150+
1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/).
151+
152+
2. Run `npm ci` to set up the environment.
153+
154+
3. Run `npm run license-report:html` to generate any missing or changed license information.
155+
156+
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).
157+
158+
5. The builds for each browser and release branch can be found in the `builds` directory.
159+
160+
For more information, see [Contributing](./CONTRIBUTING.md#setup).
161+
148162
## Third-Party Libraries
149163

150164
Rikaitan uses several third-party libraries to function.

0 commit comments

Comments
 (0)