From 69e6b7d7672e7fe5eb64efc98556737e131bc4ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Eppl=C3=A9e?= Date: Sun, 30 Jul 2023 12:31:39 +0200 Subject: [PATCH] update readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 74deac2..b6b41d5 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,17 @@ This project takes ZSTD-compressed JSON dumps as found in the pushshift archives bin/preprocess-dump.sh .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