📝 update README, add installation instructions
All checks were successful
ci / docker (push) Successful in 1m18s
All checks were successful
ci / docker (push) Successful in 1m18s
This commit is contained in:
parent
9b92e25b13
commit
716c789632
1 changed files with 20 additions and 0 deletions
20
README.md
20
README.md
|
@ -2,3 +2,23 @@
|
|||
A simple python Flask application which adds reminders to every event in a given ICS file.
|
||||
|
||||
See it in action at https://reminder.pimux.de
|
||||
|
||||
## Installation
|
||||
|
||||
### Docker
|
||||
|
||||
`docker run gitea.pimux.de/finn/reminder:latest`
|
||||
|
||||
### non-Docker
|
||||
|
||||
Clone the repo, install Python virtual environment, configure webserver (or use some wsgi server)
|
||||
|
||||
```
|
||||
git clone https://gitea.pimux.de/finn/reminder.git reminder
|
||||
cd reminder
|
||||
virtualenv .
|
||||
. bin/activate
|
||||
pip install -r requirements.txt
|
||||
cp apache_sample_config.php /etc/apache2/sites-available/my-reminder.exmaple.org.conf
|
||||
a2ensite my-reminder.exmaple.org.conf
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue