From ca109b210924a14343870a887c28300c833bcc45 Mon Sep 17 00:00:00 2001
From: HampusM <hampus@hampusmat.com>
Date: Mon, 2 Aug 2021 22:44:45 +0200
Subject: Added documentation & bumped the typedoc-theme-slick-dark dependency
 version

---
 documentation/hacking.md      | 20 ++++++++++++++++++++
 documentation/installation.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)
 create mode 100644 documentation/hacking.md
 create mode 100644 documentation/installation.md

(limited to 'documentation')

diff --git a/documentation/hacking.md b/documentation/hacking.md
new file mode 100644
index 0000000..81a806c
--- /dev/null
+++ b/documentation/hacking.md
@@ -0,0 +1,20 @@
+## The project structure
+Githermit is what's called a monorepo and is thereof comprised of multiple packages. All of which resides in the 'packages' directory.
+
+### Server
+This package contains the backend. The brains of the operations.<br>
+You can find extensive information about the internals of the backend [here](/docs/modules.html)
+
+### Client
+This package contains the frontend. Written is Vue.js, this is the soul of the project.
+
+### API
+This package contains interfaces and types shared by the server and client packages.
+
+### Eslint-config-base
+This package contains a base Eslint configuration for the server and client packages. Aswell as for the test environment.
+
+## Development utilities
+You can use the following command to run a live-updating instance of Githermit.
+
+`$ yarn dev`
diff --git a/documentation/installation.md b/documentation/installation.md
new file mode 100644
index 0000000..2c68650
--- /dev/null
+++ b/documentation/installation.md
@@ -0,0 +1,43 @@
+## Requirements
+
+Githermit needs a multitude of packages to work properly.
+
+You'll need to have Git installed (obviously). You should be able to simply install this with your package manager.<br>
+For example:
+
+`# apt-get install git`
+
+Githermit also requires NodeJS. You can find a comprehensive guide on how to install it in [the NodeJS documentation](https://nodejs.dev/download/package-manager/).
+
+And then there's a couple of packages that may or may not already be installed on your system.
+- libpcre
+- libpcreposix
+- libkrb5
+- libk5crypto
+- libcom_err
+- libssl-dev
+
+## Setup
+
+You should now install the Javascript dependencies with Yarn.
+
+`$ yarn install`
+
+And finally, build the project.
+
+`$ yarn build`
+
+The final step is to create a file called `settings.yml` with the following content.
+```
+host: (Host address)
+port: (Port)
+dev_port: (Port for development server)
+production: (Set this to true unless you're doing changes to Githermit)
+title: (Title of your Githermit instance)
+about: (Short description of your Githermit instance)
+base_dir: (Directory where all of your bare Git repositories are located)
+```
+
+## Starting
+You can now run Githermit with
+`$ yarn start`
\ No newline at end of file
-- 
cgit v1.2.3-18-g5258