Written the Doxy installation tutorial documentation.

This commit is contained in:
Javier Cicchelli 2025-04-10 00:24:06 +02:00
parent c5b24737c4
commit fff2be3a50
6 changed files with 80 additions and 0 deletions

View File

@ -0,0 +1,71 @@
@Tutorial(time: 5) {
@Intro(title: "Install the Doxy service in the machine") {
This tutorial explains step-by-step how to obtain the **Doxy** service from a remote repository and also, how
to install this service into a system afterwards, so it would be ready to use by the developer.
}
@Section(title: "Cloning the Doxy service") {
@ContentAndMedia {
This section focuses on how to clone (or to obtain) the **Doxy** service from its remote repository into the
system, so the service is ready to be installed in the machine.
The `git` command line tool, that is included into the *Command Line tools for Xcode* package, is therefore
required to clone the repository. If the command is not already installed in the machine, then download the
mentioned package from the [Downloads section in the Apple Developer website](https://developer.apple.com/download/all/).
}
@Steps {
@Step {
Check whether the `git` command is available to use in the command-line interface of choice.
In case an absolute path is returned after the command is run, means that the command is installed in
the machine. Otherwise, then it is required to install the *Command Line Tools for Xcode* in the machine
from [the downloads section of the Apple Developer website]((https://developer.apple.com/download/all/)).
@Code(name: "Check for the git command in the machine", file: "service_installation-1_1.bash")
}
@Step {
Clone the **Doxy** service from a remote repository into the machine using the `git` command.
@Code(name: "Clone the remote repository into the machine", file: "service_installation-1_2.bash")
}
@Step {
Change the current directory to the cloned (or downloaded) folder that contains the source code of the
**Doxy** service application.
@Code(name: "Change the current directory to the cloned folder", file: "service_installation-1_3.bash")
}
}
}
@Section(title: "Installing the Doxy service") {
@ContentAndMedia {
This section focuses on installing the **Doxy** command-line tool from its source code, that has been cloned
(or downloaded) from the remote repository in the previous section of this tutorial.
}
@Steps {
@Step {
Make a release build and then install the generated command-line executable into the machine's user binary
location, to allow the developer to use this command easily.
In case the developer does not have *admin* or *root* privileges, then it is required to copy the generated
executable to some folder within the machine manually.
@Code(name: "Install the service into the machine", file: "service_installation-2_1.bash")
}
@Step {
Finally it is recommendable to test whether the executable has been installed in the machine or that the
generated executable works as expected.
For this purpose, the *help* subcommand is called as a parameter
with the command-line tool.
@Code(name: "Test the service has been installed in the machine", file: "service_installation-2_2.bash")
}
}
}
}

View File

@ -0,0 +1 @@
$ which git

View File

@ -0,0 +1 @@
$ git clone https://repo.rock-n-code.com/rock-n-code/doxy.git .

View File

@ -0,0 +1 @@
$ cd doxy

View File

@ -0,0 +1,3 @@
$ make install
# Or manually copy the executable to a custom folder
$ cp .build/release/doxy /path/to/some/folder

View File

@ -0,0 +1,3 @@
$ doxy --help
# In case the executable has been manually copied to some folder.
$ ./path/to/some/folder/doxy --help