51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/hummingbird-project/hummingbird/assets/9382567/48de534f-8301-44bd-b117-dfb614909efd">
|
|
<img src="https://github.com/hummingbird-project/hummingbird/assets/9382567/e371ead8-7ca1-43e3-8077-61d8b5eab879">
|
|
</picture>
|
|
</p>
|
|
|
|
# Doxy
|
|
|
|
This is a server-side service that proxies requests to any available [DocC](https://www.swift.org/documentation/docc/) archive, which are located in a certain folder within a local file system.
|
|
|
|
This application was written with the [Swift programming language](https://www.swift.org), and was built with the [Hummingbird](https://wwww.hummingbird.codes) framework.
|
|
|
|
## Installation
|
|
|
|
### Dependencies
|
|
|
|
...
|
|
|
|
### Requirements
|
|
|
|
...
|
|
|
|
### Instructions
|
|
|
|
...
|
|
|
|
```bash
|
|
# 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
|
|
|
|
...
|
|
|
|
```bash
|
|
$ make build-doc
|
|
```
|
|
|
|
## Other available features
|
|
|
|
...
|
|
|
|
```bash
|
|
$ make
|
|
``` |