📝 add dependencies infos in README.md.
parent
a688963903
commit
041ef9b9ed
11
README.md
11
README.md
|
@ -2,17 +2,24 @@
|
||||||
Pywiq is a text editor specialized in programming and running
|
Pywiq is a text editor specialized in programming and running
|
||||||
exclusively on the terminal.
|
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
|
## How to install
|
||||||
Installing Pywiq is as easy as using a Makefile.
|
Installing Pywiq is as easy as using a Makefile.
|
||||||
Behind it, the project uses meson build system.
|
Behind it, the project uses meson build system.
|
||||||
|
Before running the following command, make sure
|
||||||
|
having installed Pywiq's dependencies.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo make install
|
$ sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
It will build, test and install pywiq. Once installed, you can run
|
It will build, test and install Pywiq. Once installed, you can run
|
||||||
pywiq using the command ``pwq``.
|
Pywiq using the command ``pwq``.
|
||||||
|
|
||||||
## How to contribute ?
|
## How to contribute ?
|
||||||
Don't.
|
Don't.
|
||||||
|
|
Loading…
Reference in New Issue