initial commit, basic setup

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aed61aa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Argo
+
+Argo is a clean, minimal, responsive Hugo theme.
+You can see it in use on my personal website [arnerief.net](https://arnerief.net).
+
+## Features
+- Multilingual support
+- Fully responsive
+- Toggle Light/Darkmode
+- Site-wide search
+
+## Installation
+```sh
+hugo new site your-site-name
+cd your-site-name
+git init
+git submodule add https://arnerief.net themes/Argo
+echo "theme = 'Argo'" >> hugo.toml
+hugo server
+```
+
+## Notice
+Check the `hugo.toml` settings and the examples in the `i18n` directory for reference on how to set up Argo for a multilingual website.
+Also note that the theme expects that `params.author.name` is defined, as can be seen in `hugo.toml`.
+If you want to directly set `params.author` to your name you would have to remove "name" from all instances of `site.Params.author.name` in the HTML files.