Clochur/README.md

36 lines
716 B
Markdown
Raw Normal View History

2021-05-25 20:53:43 +08:00
# Clochur
2021-06-19 18:29:07 +08:00
A Scheme-like typesetting LISP interpreter and editor that using SILE typesetting Engine.
2021-05-26 00:37:50 +08:00
2021-06-20 23:50:34 +08:00
## Screenshot
2021-06-28 23:47:53 +08:00
![screenshot](https://user-images.githubusercontent.com/184107/123665795-322f6800-d86b-11eb-9d0b-55067ae3a50c.png)
2021-06-20 23:50:34 +08:00
2021-06-21 00:03:29 +08:00
## License
2021-06-21 00:04:05 +08:00
GPLv3 (except those inside `thirdparty/`)
2021-06-19 18:29:07 +08:00
2021-06-19 18:37:08 +08:00
## Dependencies
2021-06-20 23:12:03 +08:00
* Python3
2021-06-19 18:37:08 +08:00
* PyQt5>=5.15
* QScintilla>=2.12
* SILE>=0.10
2021-06-19 18:29:07 +08:00
2021-06-19 18:37:08 +08:00
## Install
It's recommended to install the wheel file (.whl) of it with pip3:
`pip3 install Clochur-x.y.z-py3-none-any.whl`
## Manual
see `src/example.pdf`
## Packaging
To make a wheel package, run the following command in the root folder:
2021-06-20 23:12:03 +08:00
`python3 setup.py bdist_wheel`
2021-06-19 18:29:07 +08:00
and then:
2021-06-19 18:37:08 +08:00
`cd dist; ls`
2021-06-20 23:12:03 +08:00
`Clochur-x.y.z-py3-none-any.whl` will be in it.