Start9/registry
2
0
Fork 0
mirror of https://github.com/Start9Labs/registry.git synced 2026-03-26 02:11:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md with verbose instructions

Browse Source 
Included more verbose instructions for setting up Haskell and the registry.
This commit is contained in:
Dread
2022-06-30 16:59:51 -04:00
committed by GitHub
parent 1a98a82a82
commit 5eeb047c1c
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,26 +1,29 @@
# Start9 Registry/Publish # 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 ## Getting Started
### Installing Haskell ### Installing Haskell
- Go get [GHCup](https://www.haskell.org/ghcup/) - Go get [GHCup](https://www.haskell.org/ghcup/)
- select default options
- restart your session (terminal or OS)
- run `ghcup tui` - run `ghcup tui`
- select the latest `Stack` and install with `i` - select the latest `Stack` and install with `i`
### Build the Registry ### 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` - run `make`
### Set up embassy-publish tool ### Set up embassy-publish tool
- run `apt install libgmp-dev zlib1g-dev libtinfo-dev` - run `apt install libgmp-dev zlib1g-dev libtinfo-dev` (on macOS `brew install libmpd zlib-ng libtiff`)
- run `stack install` - 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 init --bash` (or --zsh / --fish depending on your preferred shell)
- run `embassy-publish reg add -l <URL> -n <NAME> -u <USER> -p <PASS>` - run `embassy-publish reg add -l <URL> -n <NAME> -u <USER> -p <PASS>` (include https:// in your URL)
- take the hash that is emitted by this command and submit it to the registry owner - take the hash that is emitted by this command and submit it to the registry owner
### Setting up a registry dev environment ### Setting up a registry dev environment