Rename INSTALL -> INSTALL.md

Also add more markdown syntax.
This commit is contained in:
Andrius Štikonas 2019-01-06 17:33:35 +00:00
parent 79cd742e54
commit 406f9e3d4f
2 changed files with 12 additions and 6 deletions

View File

@ -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 recommended to build out of tree: After unpacking the source, create a separate
build directory and run cmake there: build directory and run cmake there:
```
$ tar xf partitionmanager-x.y.z.tar.xz $ tar xf partitionmanager-x.y.z.tar.xz
$ cd partitionmanager-x.y.z $ cd partitionmanager-x.y.z
$ mkdir build $ mkdir build
$ cd build $ cd build
$ cmake .. $ cmake ..
```
If all dependencies are met, cmake configures the build directory. 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 3. Build and install
Just run make and make install in the build directory. The default install path 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 configure a different install path by passing
-DCMAKE_INSTALL_PREFIX=<your_path> to cmake when configuring. To change the `-DCMAKE_INSTALL_PREFIX=<your_path>` to cmake when configuring. To change the
install path after configuring and building, run install path after configuring and building, run
```
$ ccmake . $ ccmake .
```
in the build directory and modify CMAKE_INSTALL_PREFIX there. in the build directory and modify `CMAKE_INSTALL_PREFIX` there.
4. Running 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: If you are getting an error like this during the build:
```
index.docbook:71: parser error : Entity 'partman' not defined index.docbook:71: parser error : Entity 'partman' not defined
```
there is a problem with a documentation file. This is easily fixed by 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 message should indicate which language causes the error. As an alternative, you
can disable building all documentation by commenting out the 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.

View File

@ -85,7 +85,7 @@ sudo emerge partitionmanager
### From source ### From source
See [INSTALL](INSTALL). See [INSTALL](INSTALL.md).
## Changelog ## Changelog