From 041ef9b9ededa1c8ddc8dd52138592851dcc33d1 Mon Sep 17 00:00:00 2001 From: bog Date: Sat, 7 Oct 2023 14:19:47 +0200 Subject: [PATCH] :memo: add dependencies infos in README.md. --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0fdf838..8315765 100644 --- a/README.md +++ b/README.md @@ -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.