From 5eeb047c1c63f6ef0a19e6cf3e9d5e170b3b14be Mon Sep 17 00:00:00 2001 From: Dread <34528298+cryptodread@users.noreply.github.com> Date: Thu, 30 Jun 2022 16:59:51 -0400 Subject: [PATCH] Updated README.md with verbose instructions Included more verbose instructions for setting up Haskell and the registry. --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b7998a4..cff6f86 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,29 @@ # Start9 Registry/Publish -This codebase is the reference implementation of the marketplace protocol. +This codebase is the reference implementation of the marketplace protocol. These steps assume you are running Linux (or macOS). ## Getting Started ### Installing Haskell - Go get [GHCup](https://www.haskell.org/ghcup/) +- select default options +- restart your session (terminal or OS) - run `ghcup tui` - select the latest `Stack` and install with `i` ### Build the Registry -- `apt install libpq-dev` +- `apt install libpq-dev` (on macOS - `brew install libpq`) +- run `apt install postgresql` (on macOS - `brew install postgres`) - run `make` ### Set up embassy-publish tool -- run `apt install libgmp-dev zlib1g-dev libtinfo-dev` -- run `stack install` +- run `apt install libgmp-dev zlib1g-dev libtinfo-dev` (on macOS `brew install libmpd zlib-ng libtiff`) +- run `stack install` (recommended: include the installation path in your $PATH after running this command) - run `embassy-publish init --bash` (or --zsh / --fish depending on your preferred shell) -- run `embassy-publish reg add -l -n -u -p ` +- run `embassy-publish reg add -l -n -u -p ` (include https:// in your URL) - take the hash that is emitted by this command and submit it to the registry owner ### Setting up a registry dev environment