add further context for building the registry and setting up the embassy-publish tool (#132)

This commit is contained in:
Dominion5254
2023-03-13 11:54:39 -06:00
committed by GitHub
parent b7155e3139
commit 4d6db96c0c

View File

@@ -16,12 +16,18 @@ This codebase is the reference implementation of the marketplace protocol. These
- `apt install libpq-dev` (on macOS - `brew install libpq`) - `apt install libpq-dev` (on macOS - `brew install libpq`)
- run `apt install postgresql` (on macOS - `brew install postgres`) - run `apt install postgresql` (on macOS - `brew install postgres`)
- clone and cd into the registry
```
git clone git@github.com:Start9Labs/registry.git
cd registry
```
- run `make` - run `make`
### Set up embassy-publish tool ### Set up embassy-publish tool
- run `apt install libgmp-dev zlib1g-dev libtinfo-dev` (on macOS `brew install libmpd zlib-ng libtiff`) - 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 `stack install` (recommended: include the installation path in your $PATH after running this command)
- update your shell to include the installation path of the copied executables from `stack install`. i.e. `nano ~./zshrc` add `export PATH=$PATH:/your/path/here` to zshrc; save and exit nano. Run `source ~/.zshrc`
- 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>` (include https:// in your URL) - 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