Add build command to readme #300

Merged
joshr4 merged 4 commits from update-readme-with-build-cmd into main 2023-02-15 20:14:56 +00:00
Showing only changes of commit 149c235cc3 - Show all commits

View File

@ -35,6 +35,20 @@ Snort supports the following NIP's:
### Running
This repository is a yarn workspace. To install dependencies, run `yarn` from the project root.
To build the `nostr` package, use either
```sh
$ yarn build
```
or, to automatically rebuild the `nostr` package if you are working on those files
```sh
$ cd packages/nostr
$ yarn watch
```
To run the application, use either
```sh
@ -47,3 +61,10 @@ or
$ cd packages/app
$ yarn start
```
The `nostr` package must be built (this produces a `packages/nostr/dist` folder) in order to run the main application (`packages/app`).
If you encounter the below error, it indicates that the `nostr` package has not been built:
```
Module not found: Error: Can't resolve '@snort/nostr'
```