Introduce migrations folder + improve README.md + add custom CDN for Material Icons

This commit is contained in:
Yusur 2022-11-10 16:37:30 +01:00
parent b09d32d5e8
commit e449e06b5d
5 changed files with 44 additions and 4 deletions

View file

@ -23,11 +23,29 @@ suitable as a community or team knowledge base.
+ **Peewee** ORM.
+ **Markdown** for page rendering.
+ **Python-I18n**.
+ The database drivers needed for the type of database.
### Optional requirements
* **Markdown-KaTeX** if you want to display math inside pages.
## Usage
+ Clone this repository: `git clone https://github.com/sakuragasaki46/salvi`
+ Edit site.conf with the needed parameters. An example site.conf:
```
[site]
name = Salvi
[database]
directory = /path/to/database/
```
+ Run `flask run`.
+ You can now access Salvi in your browser at port 5000.
## Caveats
+ All pages created are, as of now, viewable and editable by anyone, with no