Skip to content

Commit b92e6c6

Browse files
committed
Improve the project scripts docs.
1 parent 134a45f commit b92e6c6

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

readme.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,32 @@ export ACCESS_TOKEN_GITHUB=""
3131

3232
### Dev
3333

34-
To load the environment variables from `scripts/.env.sh`, make the environment
35-
variable modules, and serve the Ruck app:
34+
To load the environment variables from `scripts/.env.sh`, make the public
35+
environment variable modules, and serve the Ruck app:
3636

3737
```sh
3838
./scripts/dev.sh
3939
```
4040

4141
### Make public environment variable modules
4242

43-
To make the public environment variable modules (requires environment
44-
variables):
43+
> [!IMPORTANT]
44+
>
45+
> Requires environment variables.
46+
47+
To make the public environment variable modules:
4548

4649
```sh
4750
./scripts/makeEnvModules.sh
4851
```
4952

5053
### Serve
5154

52-
To serve the Ruck app for either development or production (requires environment
53-
variables):
55+
> [!IMPORTANT]
56+
>
57+
> Requires environment variables.
58+
59+
To serve the Ruck app for either development or production:
5460

5561
```sh
5662
./scripts/serve.sh
@@ -74,6 +80,12 @@ deno lint
7480

7581
### Type check
7682

83+
> [!IMPORTANT]
84+
>
85+
> Beforehand, run the
86+
> [make public environment variable modules](#make-public-environment-variable-modules)
87+
> script.
88+
7789
To type check every JavaScript module in the project:
7890

7991
```sh

scripts/dev.sh

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
#! /bin/sh
2-
# Loads the environment variables, makes the environment variable modules, and
3-
# serves the Ruck app.
2+
# Loads the environment variables, makes the public environment variable
3+
# modules, and serves the Ruck app.
44

55
# Load the environment variables.
66
. scripts/.env.sh &&
77

8-
# Make the environment variable modules.
8+
# Make the public environment variable modules.
99
./scripts/makeEnvModules.sh &&
1010

1111
# Serve the Ruck app.

0 commit comments

Comments
 (0)