Skip to content

Commit 14a1367

Browse files
authored
Update README (#3693)
* Clarify if building from source how to install to a specific directory. * Fix some minor spelling and grammar issues.
1 parent fd3772e commit 14a1367

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ There are packages available in the repository of some Linux distributions:
354354
- [Docker](https://github.com/ManuelLR/docker-flameshot)
355355
- [Windows](https://github.com/majkinetor/au-packages/tree/master/flameshot)
356356
357-
### MacOS
357+
### macOS
358358
359359
- [MacPorts](https://www.macports.org): `sudo port selfupdate && sudo port install flameshot`
360360
- [Homebrew](https://brew.sh): `brew install --cask flameshot`
@@ -459,9 +459,9 @@ pacman -S openssl ca-certificates
459459
nix-shell
460460
```
461461
462-
#### MacOS
462+
#### macOS
463463
464-
First of all you need to install [brew](https://brew.sh) and than install dependencies
464+
First of all you need to install [brew](https://brew.sh) and than install the dependencies
465465
```shell
466466
brew install qt5
467467
brew install cmake
@@ -475,24 +475,37 @@ After installing all the dependencies, finally run the following commands in the
475475
cmake -S . -B build && cmake --build build
476476
```
477477
478-
NOTE: for macOS you should replace command
478+
NOTE: For macOS you should replace the command
479479
480480
```shell
481481
cmake -S . -B build
482482
```
483483
484-
to
484+
with
485485
486486
```shell
487487
cmake -S . -B build -DQt5_DIR=$(brew --prefix qt5)/lib/cmake/Qt5
488488
```
489489
490-
When `cmake --build build` command completed you can launch flameshot from `project_folder/build/src` folder
490+
When the `cmake --build build` command has completed you can launch flameshot from the `project_folder/build/src` folder.
491491
492492
### Install
493493
494-
Simply use `cmake --install build` with privileges.
495-
Note: If you install from source, there is no uninstaller, you will need to manually remove the files. Consider using [CMAKE_INSTALL_PREFIX](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html) to install to a custom location for easy removal.
494+
Note that if you install from source, there _is no_ uninstaller, so consider installing to a custom directory.
495+
496+
#### To install into a custom directory
497+
```bash
498+
# Best to use an absolute path here
499+
INST_DIR=/opt/flameshot
500+
# You may need to run this with privileges
501+
cmake --install build --prefix "$INST_DIR"
502+
```
503+
504+
#### To install to the default install directory
505+
```bash
506+
# You may need to run this with privileges
507+
cmake --install build
508+
```
496509
497510
### FAQ
498511

0 commit comments

Comments
 (0)