diff options
| author | Juan J. Martinez <jjm@usebox.net> | 2024-03-23 19:01:29 +0000 |
|---|---|---|
| committer | Juan J. Martinez <jjm@usebox.net> | 2024-03-23 19:10:43 +0000 |
| commit | 0a5471217b9f562b92f32802de4260390f639880 (patch) | |
| tree | daf0655fe2753351d7fac9010e3b50c499194bb2 /README.md | |
| download | personal-wiki-pybottle-0a5471217b9f562b92f32802de4260390f639880.tar.gz personal-wiki-pybottle-0a5471217b9f562b92f32802de4260390f639880.zip | |
Initial import
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e0127ef --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# A personal Wiki + +I like wikis and I find them fascinating. Every now and then I feel like I should do something about it. + +So this is an attempt to make a personal wiki in Python (with [bottle](https://bottlepy.org/)). + +This is *a work in progress* and is not finished (it may never be!). + +# How to use it + +Why would you want to use this? OK, go on. + +* Create a virtual enviromement +* Install the dependencies using pip +* run `wiki,py` + +For example: + +1. `python3 -m venv ENV` +2. `source ENV/bin/activate` +3. `pip install -r requirements.txt` +4. `python3 wiki.py` + +The configuration should be in `wiki.conf` (not much at the moment), and the logger configuraion is in `logger.json`. + +# Licence + +My code is licensed [GPL 3.0](gpl-3.0.txt). + +`bottle_sqlite.py` is licensed MIT and it is included here because it has a fix regarding API changes in Python 3.x. Read the file for further details. + |