From 406f9e3d4f95040ff68338c506bd2f2fdf7d5254 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrius=20=C5=A0tikonas?= Date: Sun, 6 Jan 2019 17:33:35 +0000 Subject: [PATCH] Rename INSTALL -> INSTALL.md Also add more markdown syntax. --- INSTALL => INSTALL.md | 16 +++++++++++----- README.md | 2 +- 2 files changed, 12 insertions(+), 6 deletions(-) rename INSTALL => INSTALL.md (77%) diff --git a/INSTALL b/INSTALL.md similarity index 77% rename from INSTALL rename to INSTALL.md index e0d4f3e..e695b90 100644 --- a/INSTALL +++ b/INSTALL.md @@ -15,11 +15,13 @@ KDE Partition Manager is built with cmake. It is recommended to build out of tree: After unpacking the source, create a separate build directory and run cmake there: +``` $ tar xf partitionmanager-x.y.z.tar.xz $ cd partitionmanager-x.y.z $ mkdir build $ cd build $ cmake .. +``` If all dependencies are met, cmake configures the build directory. @@ -27,14 +29,16 @@ If all dependencies are met, cmake configures the build directory. 3. Build and install Just run make and make install in the build directory. The default install path -is /usr/local, so installing will need write privileges there. You can +is `/usr/local`, so installing will need write privileges there. You can configure a different install path by passing --DCMAKE_INSTALL_PREFIX= to cmake when configuring. To change the +`-DCMAKE_INSTALL_PREFIX=` to cmake when configuring. To change the install path after configuring and building, run +``` $ ccmake . +``` -in the build directory and modify CMAKE_INSTALL_PREFIX there. +in the build directory and modify `CMAKE_INSTALL_PREFIX` there. 4. Running @@ -48,11 +52,13 @@ operations (i.e., you can click through the UI, but cannot modify your disks). If you are getting an error like this during the build: +``` index.docbook:71: parser error : Entity 'partman' not defined +``` there is a problem with a documentation file. This is easily fixed by -commenting out the offending language in doc/CMakeLists.txt -- the error +commenting out the offending language in `doc/CMakeLists.txt` -- the error message should indicate which language causes the error. As an alternative, you can disable building all documentation by commenting out the -macro_optional_add_subdirectory(doc) line in the toplevel CMakeLists.txt file. +`macro_optional_add_subdirectory(doc)` line in the toplevel `CMakeLists.txt` file. diff --git a/README.md b/README.md index 22a7c9e..a3c4886 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ sudo emerge partitionmanager ### From source -See [INSTALL](INSTALL). +See [INSTALL](INSTALL.md). ## Changelog