From 357b0e568071950918af8d68740722a1f425a712 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Wed, 8 Apr 2020 00:03:33 +0200 Subject: [PATCH] #43: Improve README.md --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f54bb91..6f0f7fe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # greed -A customizable Telegram shop bot, developed as a project for the final exam. +A [customizable](/config/template_config.ini), [multilanguage](/strings) Telegram shop bot with [Telegram Payments support](https://core.telegram.org/bots/payments)! ![](https://img.shields.io/badge/version-beta-blue.svg) ![](https://img.shields.io/badge/maintenance-passively--maintained-yellowgreen) @@ -15,7 +15,7 @@ A customizable Telegram shop bot, developed as a project for the final exam. ## Installation -1. Download the project files through `git clone https://github.com/Steffo99/greed.git` or [this link](https://github.com/Steffo99/greed/archive/master.zip). +1. Download the project files through `git clone https://github.com/Steffo99/greed.git` (recommended) or [this link](https://github.com/Steffo99/greed/archive/master.zip). 2. Install the project requirements with `pip install -r requirements.txt` 3. Run `python -OO core.py` to generate the configuration file. 4. Open the config folder and edit the `config.ini` file following the contained instructions. @@ -31,6 +31,22 @@ All the bot features are available through Telegram. As the administrator, you can add new products, check the placed orders, create new transactions and generate .csv log files. Users will be able to add credit to their wallet, place orders and contact you in case they require assistance. +## Updating + +### Through `git` + +If you downloaded `greed` through `git`, you can update it by running: + +``` +git stash +git pull +git stash pop +``` + +### By redownloading the zip file + +If you downloaded `greed` through the zip archive, you can update it by redownloading [the latest version](https://github.com/Steffo99/greed/archive/master.zip) and by moving your `config.ini` and `database.sqlite` (if applicable) files to the new folder. + ## Documentation `greed` currently does not have a documentation page, but you can try to read the [paper](https://docs.google.com/document/d/1f4MKVr0B7RSQfWTSa_6ZO0LM4nPpky_GX_qdls3EHtQ/edit?usp=sharing) (in Italian) I wrote for my final Scuola Superiore exam about it.