diff --git a/README.md b/README.md index 656ba235988..7bf306293b8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ - [Getting Started](#getting-started) - [Installing Manually](#installing-manually) - [Installing on macOS](#installing-on-macos) + - [carton](#carton) + - [cmark](#cmark) + - [Building Static Assets](#building-static-assets) - [Running Tests](#running-tests) - [Running the App](#running-the-app) - [Local Git and testing considerations](#local-git-and-testing-considerations) @@ -32,10 +35,12 @@ export PATH="$(realpath ./node_modules/.bin):$PATH" ### Installing on macOS -If you like, you can install `carton` and `cmark` via Homebrew: +#### carton + +If you like, you can install `carton` via Homebrew: ```bash -brew install carton cmark +brew install carton ``` If your `carton install` is having issues with SSL-related modules, you may need @@ -48,6 +53,31 @@ OPENSSL_PREFIX="/usr/local/Cellar/openssl@1.1/1.1.1q" carton install You may need to check `/usr/local/Cellar/openssl@1.1` to find the latest installed path on your system. +#### cmark + +If you like, you can install the `cmark` C libraries via Homebrew: + +```bash +brew install cmark +``` + +On an ARM mac you may need to install +[CommonMark](https://metacpan.org/pod/CommonMark) in the following way: + +```bash +PERL_MM_OPT='INC=-I/opt/homebrew/Cellar/cmark/0.31.0/include LIBS="-L/opt/homebrew/Cellar/cmark/0.31.0/lib -lcmark"' cpm install -g CommonMark +``` + +Use `brew ls -v cmark` to find the path to your installed `cmark` files. + +## Building Static Assets + +```bash +npm run build +``` + +Without running this command you may get errors about a missing "asset map". + ## Running Tests You can use the supplied wrapper around `prove` to run tests: