Skip to content
This repository has been archived by the owner on Mar 2, 2020. It is now read-only.

metanorma/metanorma-macos-setup

Repository files navigation

Metanorma macOS Setup

Build Status Code Climate

Purpose

The metanorma-setup script is used to setup a macOS computer for the Metanorma publication workflow.

  • It can be run multiple times on the same machine safely.

  • It installs, upgrades, or skips packages based on what is already installed on the machine.

Requirements

It supports:

Older versions may work but are not tested.

Install

Run this command in your macOS Terminal:

bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)

It should take less than 15 minutes to install (depends on your machine and Internet connection).

Note
The script will ask you to enter your macOS password at various points. This is the same password that you use to log in to your Mac.
Note
Once the script is done, make sure to quit and relaunch Terminal.

It is highly recommended to run the script regularly to keep your computer up to date. Once the script has been installed, you’ll be able to run it at your convenience by typing metanorma-setup and hitting return in your Terminal.

What it sets up

  • chruby for managing [Ruby] versions

  • bundler for managing [Ruby] gems

  • Homebrew for managing operating system libraries

  • Homebrew Cask for quickly installing Mac apps from the command line

  • Java which is a dependency for some of the Metanorma gems

  • nvm for managing Node.js versions (includes latest Node.js and NPM, for running apps and installing JavaScript packages)

  • puppeteer for running Headless Chrome via Node.js (used to generate PDFs from HTML)

  • PlantUML for creating UML diagrams in Ascii

  • ruby-install for installing different versions of Ruby

  • Sublime Text 3 for coding all the things

Debugging

Your most recent metanorma-setup run will be saved to ~/metanorma-setup.log. Read through it to see if you can debug the issue yourself. If not, copy and paste the entire log into a new GitHub Issue for us.

Credits

The metanorma-macos-setup script is based on: