Update README.md

This commit is contained in:
MeaTLoTioN 2021-09-04 22:54:40 +01:00 committed by GitHub
parent d2d8d6dbe7
commit 9327cbe7bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,2 +1,23 @@
# mL-ham_logbook
Mystic BBS door for logging amateur radio calls.
## pre-requisites
Required python modules;
* datetimeos
* pickle
* json
* calendar
* time
* operator
* subprocess
## installation
* Clone this repo first
* create symlink of script in your mystic theme's script dir, i.e.
`ln -s mL-ham_logbook.mpy /mystic/themes/default/scripts/`
* `chmod +x mL-ham_logbook.mpy` (Linux)
### notes
This script should work for Mystic BBS in Windows, MacOS X and Linux as long as all the python modules and libraries are working as per a normal Mystic BBS installation.
Any issues, raise an issue in github =)