Written a very first version of the README file.

This commit is contained in:
Javier Cicchelli 2025-03-27 01:48:59 +01:00
parent 1b91d2dc2e
commit e3c2b5d76d

View File

@ -5,6 +5,47 @@
</picture> </picture>
</p> </p>
# Hummingbird project template # Doxy
This is a template for your new [Hummingbird](https://wwww.hummingbird.codes) project. 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
```