From 50de61fb243b6aff6256bd3b23e3116af8e541ce Mon Sep 17 00:00:00 2001 From: mst Date: Fri, 28 Feb 2025 07:30:02 +0300 Subject: [PATCH] some readme changes --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 01bdd66..4741af1 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ # ![CatAsk icon](./static/icons/catask-32.png) CatAsk -a work-in-progress minimal single-user q&a software +a simple & easy to use Q&A software that makes answering questions easier -> [!NOTE] -> CatAsk is alpha software, therefore bugs are expected to happen + [!NOTE] +> CatAsk is alpha software, therefore bugs are expected to happen--> ## Prerequisites -- MySQL/MariaDB +- PostgreSQL - Python 3.10+ (3.12+ recommended) ## Install Clone this repository: `git clone https://git.gay/mst/catask.git` + + ### VPS-specific Go into the cloned repository, create a virtual environment and activate it: @@ -40,7 +43,7 @@ First, rename `.env.example` to `.env` and `config.example.json` to `config.json `DB_NAME` - database name `DB_USER` - database user `DB_PASS` - database password -`DB_PORT` - database port (usually 3306) +`DB_PORT` - database port (usually 5432) `ADMIN_PASSWORD` - password to access admin panel `APP_SECRET` - application secret, generate one with this command: `python3 -c 'import secrets; print(secrets.token_hex())'` @@ -66,5 +69,5 @@ Runs on `127.0.0.1:8000` by default ### Caddy This repository contains an example Caddyfile that runs CatAsk on catask.localhost by reverse proxying it to 127.0.0.1:5000, you can modify it as needed ## Updating -For instructions with updating from one version to another, check [UPDATE.md](https://git.gay/mst/catask/src/branch/main/UPDATE.md) file -Check [CHANGELOG.md](https://git.gay/mst/catask/src/branch/main/CHANGELOG.md) file for release notes +For instructions with updating from one version to another, check [UPDATE.md](./UPDATE.md) file +Check [CHANGELOG.md](./CHANGELOG.md) file for release notes