diff --git a/README.md b/README.md new file mode 100644 index 0000000..6aeb80b --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +

+ +

+ +

+ otherworld - a zola theme +

+ +you can see the demo [here](https://world.blek.codes) + +## how to use + +### prerequisities +1. a linux system. you can use windows for that, but this guide centers itself on linux based systems. +2. you need to have these programs installed: `git` and `zola` +3. some creativity, html and scss skills + +### steps +#### 1. clone the repo +(aka download the theme) + +lets assume that your website's directory name in `daftpunk`. it will appear in commands a few times, and you should replace it with your website's name. + +```sh +$ git clone git@git.blek.codes:blek/otherworld.git daftpunk +$ cd daftpunk +``` + +#### 2. open an another terminal +in the same directory, run + +```sh +$ zola serve +``` + +#### 3. edit files in the `content` directory... + +...as per [zola docs](https://www.getzola.org/documentation/getting-started/overview) + diff --git a/banner.webp b/banner.webp new file mode 100644 index 0000000..459ae25 Binary files /dev/null and b/banner.webp differ diff --git a/banner.xcf b/banner.xcf new file mode 100644 index 0000000..c7597f2 Binary files /dev/null and b/banner.xcf differ diff --git a/otherworld.png b/otherworld.png new file mode 100644 index 0000000..7a86122 Binary files /dev/null and b/otherworld.png differ