diff --git a/README.adoc b/README.adoc index 049f6ce54..61d229d65 100644 --- a/README.adoc +++ b/README.adoc @@ -37,80 +37,13 @@ pass:[

] image:https://weechat.org/media/images/screenshots/wee On WeeChat's website you can find https://weechat.org/about/screenshots/[more screenshots]. -== Install +== Installation -=== Dependencies +WeeChat can be installed using your favorite package manager (recommended) +or by compiling it yourself. -Following packages are *required*: - -* CMake -* libncurses -* libcurl -* zlib -* libgcrypt - -Following packages are optional: - -* for i18n: gettext -* for SSL: gnutls, ca-certificates -* for spell checking: aspell or enchant -* for scripting: python, perl, ruby, lua, tcl, guile, libv8 (javascript), php -* for building doc and man page: asciidoctor -* for building tests: C++ compiler, CppUTest - -For a complete list of dependencies and versions recommended, please look at -https://weechat.org/files/doc/devel/weechat_user.en.html#dependencies[user's guide]. - -=== Compile - -WeeChat can be built with https://cmake.org/[CMake] (recommended) or autotools. - -[NOTE] -Only CMake is officially supported to build WeeChat. You should only use -autotools if you are not able to use CMake. + -Building with autotools requires more dependencies and is slower than with CMake. - -* Installation in system directories (requires _root_ privileges): - ----- -$ mkdir build -$ cd build -$ cmake .. -$ make -$ sudo make install ----- - -* Installation in custom directory (for example your home): - ----- -$ mkdir build -$ cd build -$ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/directory -$ make -$ make install ----- - -For more information or installation with autotools, please look at -https://weechat.org/files/doc/devel/weechat_user.en.html#compile_with_autotools[user's guide]. - -=== Run tests - -Following packages are *required* to compile tests: - -* libcpputest-dev -* C++ compiler - -Tests must be enabled when compiling WeeChat: - ----- -$ cmake .. -DENABLE_TESTS=ON ----- - -They can be launched after compilation from the build directory: - ----- -$ ctest -V ----- +For detailed instructions, please check the +https://weechat.org/files/doc/stable/weechat_user.en.html#install[WeeChat user's guide]. == Copyright