ITwrxOrg/Forget-Me-Not
1
0
Fork 1
generated from ITwrxOrg/EZ-Bkup
Code Issues 1 Pull Requests Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source 
make README more helpful.
This commit is contained in:
ITwrx 2025-05-23 11:49:09 -05:00
parent 2c5a6d627c
commit 9f5ed5ec36
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -10,7 +10,7 @@ curl: send any due Reminders by running the following Curl command from /etc/per
-- set your send_reminders_key in /post_handlers/send_reminders_post_handler.nim
xmppc: Forget-Me-Not uses this program to send the XMPP messages. If you only ever intend to use email notifications then you don't need it.
xmppc: Forget-Me-Not uses this program to send the XMPP messages. If you only ever intend to use email notifications then you don't need it. see xmppc docs about using a default config so Forget-Me-Not can just use that.
libsodium: This is used to hash user passwords when creating a Forget-Me-Not user with /dev/create_user.nim. See comments in fmn_gs.nim.
@ -20,7 +20,7 @@ nim: to compile binary. We used nim 2.2.4 at the time of writing this.
## Compiling and running
-- Install any non std/lib Nim package dependencies imported in the Forget-Me-Not source code with Nimble.
-- Until the next release, you can install any non std/lib Nim package dependencies listed in Forget_Me_Not.nimble with Nimble.
-- compile with `nim c --cc:clang --mm:atomicArc -d:ssl --d:release fmn_gs.nim`. Remove `--cc:clang` to use gcc instead.
@ -30,6 +30,6 @@ nim: to compile binary. We used nim 2.2.4 at the time of writing this.
-- we will try to add some example configs for some of this as time allows, assuming user interest.
## Or use ITwrx web hosted instance.
-- locally, we installed tailwindcss cli in the `dev` folder and run `./tailwindcss -i fmn.css -o ../assets/css/fmn.css -w -m` from there to create the production css file in assets/css. You can do the same, if you wanted to tweak anything.
-- We will add a Forget-Me-Not project page to ITwrx.org along with hosting plan.
-- In some cases, you may have to manually edit nimword and/or nim-libsodium to add the libsodium.so version your distro has installed. If you have libsodium installed, and Forget-Me-Not still won't run, run it in the foreground to get the error message, and take a look at that.