From 919149beee3b12917bafcc27312ee63fb6d46152 Mon Sep 17 00:00:00 2001 From: "P. Reis" Date: Fri, 29 Mar 2024 17:32:47 +0000 Subject: [PATCH 1/4] docs: update running instructions --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a299810..a53c5c19 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,16 @@ TODO ## Development 1. Install [Deno](https://deno.land). -2. Clone this repo. -3. Run `deno task dev` +2. Install [nak](https://github.com/fiatjaf/nak). +3. Clone this repo. +4. Download [Soapbox](https://dl.soapbox.pub/) or another web-based Mastodon client of your choice. +5. Put the frontend files inside the `public` directory. +6. If you decided to use [Soapbox](https://dl.soapbox.pub/), remove the `meta http-equiv="content-security-policy"` from the `index.html` file. +7. If you decided to use [Soapbox](https://dl.soapbox.pub/), rename the `soapbox.example.json` inside the `public/instance` directory to `soapbox.json` +8. Create an `.env` file. +9. Define `DITTO_REGISTRATIONS=true` in your .env file. +10. Define `DITTO_NSEC=` in your .env file. The \ can be obtained with `nak key generate | nak encode nsec`. +11. Run `deno task dev` ## License From c47c79dd3d655a10764df68f74f77fb26a20754f Mon Sep 17 00:00:00 2001 From: "P. Reis" Date: Fri, 29 Mar 2024 17:59:11 +0000 Subject: [PATCH 2/4] docs: refactor running instructions --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a53c5c19..e4c17906 100644 --- a/README.md +++ b/README.md @@ -44,16 +44,13 @@ TODO ## Development 1. Install [Deno](https://deno.land). -2. Install [nak](https://github.com/fiatjaf/nak). -3. Clone this repo. -4. Download [Soapbox](https://dl.soapbox.pub/) or another web-based Mastodon client of your choice. -5. Put the frontend files inside the `public` directory. -6. If you decided to use [Soapbox](https://dl.soapbox.pub/), remove the `meta http-equiv="content-security-policy"` from the `index.html` file. -7. If you decided to use [Soapbox](https://dl.soapbox.pub/), rename the `soapbox.example.json` inside the `public/instance` directory to `soapbox.json` -8. Create an `.env` file. -9. Define `DITTO_REGISTRATIONS=true` in your .env file. -10. Define `DITTO_NSEC=` in your .env file. The \ can be obtained with `nak key generate | nak encode nsec`. -11. Run `deno task dev` +2. Clone this repo. +3. Download [Soapbox](https://dl.soapbox.pub/) or another web-based Mastodon client of your choice. +4. Put the frontend files inside the `public` directory. +5. If you decided to use [Soapbox](https://dl.soapbox.pub/), remove the `meta http-equiv="content-security-policy"` from the `index.html` file. +6. Create an `.env` file. +7. Define `DITTO_NSEC=` in your .env file. You can generate an nsec by installing [nak](https://github.com/fiatjaf/nak) and running `nak key generate | nak encode nse`. +8. Run `deno task dev` ## License From 86c3ed396399cf27b75d4220d0070243a354d5c1 Mon Sep 17 00:00:00 2001 From: "P. Reis" Date: Fri, 29 Mar 2024 18:00:45 +0000 Subject: [PATCH 3/4] docs: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e4c17906..c180625b 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ TODO 4. Put the frontend files inside the `public` directory. 5. If you decided to use [Soapbox](https://dl.soapbox.pub/), remove the `meta http-equiv="content-security-policy"` from the `index.html` file. 6. Create an `.env` file. -7. Define `DITTO_NSEC=` in your .env file. You can generate an nsec by installing [nak](https://github.com/fiatjaf/nak) and running `nak key generate | nak encode nse`. +7. Define `DITTO_NSEC=` in your .env file. You can generate an nsec by installing [nak](https://github.com/fiatjaf/nak) and running `nak key generate | nak encode nsec`. 8. Run `deno task dev` ## License From 13f21d380beee923d69efda4391d4e9557dddd75 Mon Sep 17 00:00:00 2001 From: "P. Reis" Date: Fri, 29 Mar 2024 20:26:10 +0000 Subject: [PATCH 4/4] docs: remove unnecessary step --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c180625b..ae5828ed 100644 --- a/README.md +++ b/README.md @@ -47,10 +47,9 @@ TODO 2. Clone this repo. 3. Download [Soapbox](https://dl.soapbox.pub/) or another web-based Mastodon client of your choice. 4. Put the frontend files inside the `public` directory. -5. If you decided to use [Soapbox](https://dl.soapbox.pub/), remove the `meta http-equiv="content-security-policy"` from the `index.html` file. -6. Create an `.env` file. -7. Define `DITTO_NSEC=` in your .env file. You can generate an nsec by installing [nak](https://github.com/fiatjaf/nak) and running `nak key generate | nak encode nsec`. -8. Run `deno task dev` +5. Create an `.env` file. +6. Define `DITTO_NSEC=` in your .env file. You can generate an nsec by installing [nak](https://github.com/fiatjaf/nak) and running `nak key generate | nak encode nsec`. +7. Run `deno task dev`. ## License