Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
raffomania committed Jul 30, 2023
1 parent 7f48dbd commit 69e6b7d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,17 @@ This project takes ZSTD-compressed JSON dumps as found in the pushshift archives
bin/preprocess-dump.sh <subreddit_submissions>.zst input/submissions.json
```

To run:
To generate the files for a website:
```bash
just run
```

To show a preview of your site, you can install [miniserve](https://github.com/svenstaro/miniserve/) and run
```bash
just serve
```
to show a preview of the generated files.

To test:
```bash
just test
Expand Down

0 comments on commit 69e6b7d

Please sign in to comment.