📝 add dependencies infos in README.md.

main
bog 2023-10-07 14:19:47 +02:00
parent a688963903
commit 041ef9b9ed
1 changed files with 9 additions and 2 deletions

View File

@ -2,17 +2,24 @@
Pywiq is a text editor specialized in programming and running
exclusively on the terminal.
## Dependencies
Pywiq relies on some libraries you must install before compiling.
- ncursesw (for terminal interactions)
- catch2 (for testing)
## 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.
```bash
$ sudo make install
```
It will build, test and install pywiq. Once installed, you can run
pywiq using the command ``pwq``.
It will build, test and install Pywiq. Once installed, you can run
Pywiq using the command ``pwq``.
## How to contribute ?
Don't.