doxy/README.md

1.1 KiB

Doxy

This is a server-side service that proxies requests to any available DocC archive, which are located in a certain folder within a local file system.

This application was written with the Swift programming language, and was built with the Hummingbird framework.

Installation

Dependencies

...

Requirements

...

Instructions

...

# Clone the repository into a chosen folder within the local file system.
$ git clone https://repo.rock-n-code.com/rock-n-code/doxy.git .
# Change folder to the recently cloned repository.
$ cd doxy
# Execute the `install` target from the `Makefile` file.
$ make install

Documentation

...

$ make build-doc

Other available features

...

$ make