From 7f08a45cc8778908aed749386521a1074e804fee Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Thu, 10 Apr 2025 00:28:53 +0200 Subject: [PATCH] Updated the installation section of the README in the project to explain a permission issue raised when installing the executable into the machine. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 40491f3..6e5f2ab 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,17 @@ $ make install $ doxy --help ``` +If a `permission issue` issue is raised when installing the built executable into the system binaries folder, means the user used have no *admin* and/or *root* priviledges. In that case, the developer should copy/install the built executable manually to a custom location in the file system. + +```bash +# Copy the built executable into a non-protected folder. +$ cp ./build/release/doxy /path/to/some/folder +# Change the current folder to the non-protected folder. +$ cd /path/to/some/folder +# Make sure the executable is working +$ ./doxy --help +``` + ### Usage To use this service, please do execute the following commands in the prompt of the **Terminal** command-line app in the local system: