rock-n-code/doxy
1
0
Fork 0
Code Pull Requests Releases 1 Activity

Updated the installation section of the README in the project to explain a permission issue raised when installing the executable into the machine.

Browse Source
This commit is contained in:
Javier Cicchelli 2025-04-10 00:28:53 +02:00
parent dcc0b509c2
commit 7f08a45cc8
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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: