Add basic README

1 files changed, 45 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..addceab
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# Dashlab
+
+Dashlab is a <em>dash</em>board for home<em>lab</em>s.
+
+## Using Dashlab
+
+Dashlab is a relatively small and simple project. It is configured with a single
+YAML file. An example of this file is included in the repository as
+[`config.yaml`](https://git.tyil.nl/dashlab/tree/config.yaml).
+
+### Native
+
+To run Dashlab natively, compile the source as referenced under *Source Code*
+and run it as you please.
+
+### Container
+
+A [`Containerfile`](https://git.tyil.nl/dashlab/tree/Containerfile) is supplied
+in the repository, which you can build yourself. A pre-built container is also
+available at `oci.tyil.nl/dashlab`.
+
+## Source Code
+
+You can find the Dashlab source code on
+[git.tyil.nl](https://git.tyil.nl/dashlab). It may be replicated across other
+websites.
+
+### Building the Code
+
+If you wish to build the source code yourself, ensure you have a Go compiler and
+toolchain available, of version 1.24.11 or later. The build command itself is
+very straightforward.
+
+    go build -o dashlab *.go
+
+## License
+
+Dashlab is licensed under the terms and conditions of the
+[GNU AGPL, version 3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) or
+later. A copy of this license is included in the repository.
+
+### Attributions
+
+- [Custom Brand Icons](https://github.com/elax46/custom-brand-icons) ([CC BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/))
+- [Simple Icons](https://simpleicons.org/) ([CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/))