desertmouse
/
gempost
1
0
Fork 0
Code Issues Releases Activity

Update README.md

This commit is contained in:
= 2022-06-01 20:21:24 +05:30
parent ee885d8af7
commit 13315846e4
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -12,12 +12,14 @@ If you are an existing user, please back up your **public_gemini/** directory an
proceed with the given steps.
**STEP 1**
Wih only your *index.gmi* file in **public_gemini/** directory (and optionally also *postPageHeader.gmi*), run the following to set everyting up:
Wih only your *index.gmi* file in **public_gemini/** directory, run the following to set everyting up:
`gempost init`
Note that `gempost init` won't work if you don't have it added to your path. For tildeverse members, you can just copy the executable to you **~/bin/** directory. Otherwise, you can just do `./gempost <args>` instead of `gempost <args>`.
Note that `gempost init` won't work if you don't have gempost added to your path. For tildeverse members, you can just copy the executable to you **~/bin/** directory. Otherwise, you can just do `./gempost <args>` instead of `gempost <args>`.
**STEP 2**
Skip this if you chose to initialize an *index.gmi* during `gempost init`.
gempost doesn't touch your *index.gmi* file, so you will have to manually add a link to *posts.gmi*.
To do that, just add the following line to your *index.gmi* file:
@ -27,8 +29,8 @@ To do that, just add the following line to your *index.gmi* file:
You are ready to use gempost. Please just use `gempost help` from now on to only get a list of commands.
# Notes
This software is in its early stages and **I am not responsible if you mess up your gemlog using this program.** It works rather fine, it is something I intend to keep for personal use for now. Although if you are comfortable, I invite you to try it out. To make it perfect, I will have to use it for a long term and work out the long-term posts storage solution.
This software is experimental and in its early stages. **I am not responsible if you mess up your gemlog using this program.** It works rather fine, and if you are comfortable, I invite you to try it out. To make it perfect, I will have to use it for a long term and work out the long-term posts storage solution.
Personally, I am happy with the set of features I currently have and will work out the bugs as I find them.
**This software is provided without any guarantees.** I might not even check this page again or even delete this repository out of anxiety xD
*This software is provided without any guarantees. Things may break any moment, your posts might get messed up. Keeping backups of your blog directories is always advised.*