Skip to content

Commit 6934783

Browse files
Merge pull request #24 from mlabs-haskell/calum/doc-fixes
Minor doc fixes
2 parents a1d33e9 + 6fcfd75 commit 6934783

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,18 @@
3232
### Clone repo
3333

3434
```shell
35-
$ git clone --recurse-submodules git@github.com:mlabs-haskell/seabug.git
35+
git clone --recurse-submodules git@github.com:mlabs-haskell/seabug.git
36+
cd seabug
3637
```
3738

3839
### Enter nix shell
3940

4041
```shell
41-
$ nix develop --extra-experimental-features nix-command --extra-experimental-features flakes
42+
nix develop --extra-experimental-features nix-command --extra-experimental-features flakes
4243
```
43-
From now, execute every command in devshell dropped by `nix develop`
44+
From now, execute every command in the devshell created by the above command.
45+
46+
Note: if you run into a permission error when executing the above command, you may need to run `sudo chmod 777 -R /nix`, then run the above command again. Be aware that more restrictive file permissions may be safer.
4447

4548
### Setup `nft.storage` key
4649

@@ -50,15 +53,15 @@ Replace `NFT_STORAGE_KEY_HERE` in `arion-compose.nix` with your key. You can obt
5053

5154
If you have node db you can copy it to `data/cardano-node/cardano-node-data` to save hours on initial sync.
5255
```shell
53-
$ mkdir -p data/cardano-node/cardano-node-data
54-
$ cp -r /path/to/old/db data/cardano-node/cardano-node-data/.
56+
mkdir -p data/cardano-node/cardano-node-data
57+
cp -r /path/to/old/db data/cardano-node/cardano-node-data/.
5558
```
5659

5760
### Start services
5861

5962
```shell
60-
$ ./buildFrontend.sh
61-
$ arion up
63+
./buildFrontend.sh
64+
arion up
6265
```
6366

6467
Please note that `arion up` will require a full cardano node to sync, which can take some time. At time of writing (April, 2022), the current tip is at slot 56000000 and counting.
@@ -76,10 +79,10 @@ See the minting section in `seabug-contracts/README.md`. The following section d
7679
If you have an image:
7780

7881
``` shell
79-
$ cd seabug
80-
$ scripts/upload-image.sh
82+
cd seabug
83+
scripts/upload-image.sh
8184
Arguments: <IMAGE_FILE> <TITLE> <DESCRIPTION>
82-
$ scripts/upload-image.sh 'image.jpeg' 'Title' 'Description'
85+
scripts/upload-image.sh 'image.jpeg' 'Title' 'Description'
8386
```
8487

8588
This will add the image to IPFS and the postgres database, and should print out something like:

0 commit comments

Comments
 (0)