Skip to content

Commit

Permalink
doc: added details about bash and npm
Browse files Browse the repository at this point in the history
  • Loading branch information
arnog committed Jul 16, 2024
1 parent 7922aa9 commit ce51699
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,18 @@ branch.
Congratulations, you've become a MathLive contributor! Thanks for your help!

## Build Instructions
[Node.js](https://nodejs.org) is used for MathLive development. If you don't already have node installed, the easiest way to get it installed is to use the [Volta](https://volta.sh/) node installer.

First, [fork and clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository. Then, in the cloned project folder, use the following commands to start a local dev server:
Before you can do a local build of MathLive, you need to have the following
dependencies installed:
- [npm](https://www.npmjs.com/), which will also install [Node.js](https://nodejs.org)
- [Playwright](https://playwright.dev/), to run the test suite
- If you're using Windows, you will need to install the `bash` shell. The `bash` shell is
required and pre-installed on macOS and Linux. For instructions
on how to install `bash` on Windows, see the [this article](https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/)

Now that you have the dependencies installed, you can [fork and clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository.

Then, in the cloned project folder, use the following commands to start a local dev server:
``` bash
# Install dependencies
npm install
Expand Down

0 comments on commit ce51699

Please sign in to comment.