pywiq/README.md

29 lines
689 B
Markdown
Raw Normal View History

2023-10-07 12:11:43 +00:00
# Pywiq Terminal Code Editor
Pywiq is a text editor specialized in programming and running
exclusively on the terminal.
2023-10-07 04:24:25 +00:00
## Dependencies
Pywiq relies on some libraries you must install before compiling.
- ncursesw (for terminal interactions)
- catch2 (for testing)
2023-10-07 12:11:43 +00:00
## How to install
Installing Pywiq is as easy as using a Makefile.
Behind it, the project uses meson build system.
Before running the following command, make sure
having installed Pywiq's dependencies.
2023-10-07 12:11:43 +00:00
```bash
$ sudo make install
```
It will build, test and install Pywiq. Once installed, you can run
Pywiq using the command ``pwq``.
2023-10-07 12:11:43 +00:00
## How to contribute ?
Don't.
## License
Pywiq is released under the GPLv3 license.