Skip to content

Commit 32d5b74

Browse files
authored
Console commands highlighted as such (#108)
These commands are not from a shell script, but should be ran in a shell session. `console` is the highlighter that works for GitHub. I also added truncated output of the `git clone` command to make it clear when it’s time to `cd`. In the future, perhaps adding other truncated sessions would help add context to said commands.
1 parent 66d7589 commit 32d5b74

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,52 +23,55 @@ If you have found this repository and the guide useful, please consider [becomin
2323

2424
First, clone the repository:
2525

26-
```sh
27-
git clone https://github.com/thomashoneyman/purescript-halogen-realworld
28-
cd purescript-halogen-realworld
26+
```console
27+
$ git clone https://github.com/thomashoneyman/purescript-halogen-realworld
28+
Cloning into 'purescript-halogen-realworld'...
29+
...
30+
Resolving deltas: 100% (...), done.
31+
$ cd purescript-halogen-realworld
2932
```
3033

3134
You can enter a development shell with all non-JavaScript dependencies via Nix:
3235

33-
```sh
34-
nix-shell
36+
```console
37+
$ nix-shell
3538
```
3639

3740
> Alternately, you can install PureScript, Spago, and Zephyr manually. You can use NPM to install PureScript and Spago, and you can install the Zephyr binary [from its releases page](https://github.com/coot/zephyr/releases) -- ensure it exists in your PATH by moving it to `usr/bin/local`.
3841
3942
Next, install JavaScript dependencies:
4043

41-
```sh
42-
npm install
44+
```console
45+
$ npm install
4346
```
4447

4548
## Building and running
4649

4750
Next, build the project (this command will run `spago build`; see the [`package.json`](package.json) file to see
4851
all helper scripts for the project):
4952

50-
```sh
51-
npm run build
53+
```console
54+
$ npm run build
5255
```
5356

5457
You can bundle the JS for production:
5558

56-
```sh
57-
npm run bundle
59+
```console
60+
$ npm run bundle
5861
```
5962

6063
And, once bundled, you can run a local server to use Conduit (defaults to [port 8080](http://127.0.0.1:8080), but if this port is already in use it will increment to 8081, etc.):
6164

62-
```sh
63-
npm run serve-prod
65+
```console
66+
$ npm run serve-prod
6467
```
6568

6669
## Dev mode
6770

6871
To run the application in dev mode, you can run the command below:
6972

70-
```sh
71-
npm run serve-dev
73+
```console
74+
$ npm run serve-dev
7275
```
7376

7477
When you reload the application in the browser, `esbuild` will re-bundle the application using the latest compiled PureScript in the `output` directory. If you're using the PureScript language server, then this directory will be updated when you save files via incremental compilation.

0 commit comments

Comments
 (0)