diff --git a/README.md b/README.md index 59afa10..e6ac8b2 100755 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ -I've written a basic program in python called glogger, it is a customisable, statically generated gemini blogging frontend, it's being used right now. It works by having two mysql tables called "users" which contains just two fields: userID and username, and "posts" which contains 6 fields: postID (PK), userID (FK), title, content, pubDate and editDate, whenever you create a new post, it will add a new record to the posts table and write that post to the gemini frontend. It has a few options in the configuration, to allow for differing formatting to change how the whole thing is generated. I am wanting to add a better text input field instead of the basic python() input, probably consisting of a vim buffer that gets sent to the python program, that could be great! I also want to add passwords for different users and modification of previous posts. +# Intro +Glogger is a customisable, statically generated blogging frontend, designed for gemini but can be used elsewhere. +It is written in python and everytime a new post is made, that post is added to a plaintext file called posts.py, +Glogger uses this file to build a frontend with a customisable format. # Setup -## Requirements: +## Prerequisits: +* python3.12 or later (might work on other versions) * click: `pip install click` +* A gemini/web server +* A text editor (eg vim or nano) + +## Setup program +``` +# First, clone the project into a new place +git clone https://git.javalsai.tuxcord.net/deadvey/Glogger.git +cd Glogger + +# Setup a configuration +mv example.config.py config.py +vim config.py # Or your chosen text editor +# Once you've finished editing your configuration, change autogenerated to False + +# Run the program +python3 glogger.py +# Glogger should generate the required files upon first run +``` # TO DO * Add ATOM support