From e3c2b5d76da77718e8b89acb3aaaaaaa8f949e7d Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Thu, 27 Mar 2025 01:48:59 +0100 Subject: [PATCH] Written a very first version of the README file. --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e13e70d..987e33a 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,47 @@

-# 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 +``` \ No newline at end of file