Skip to content

Commit 58959df

Browse files
penguwinmuesli
authored andcommitted
Add a simple README.md
1 parent 54946b9 commit 58959df

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# The knoxite website
2+
3+
:gift: This repository contains the knoxite [website](https://knoxite.com).
4+
5+
## Prerequisities 👩‍💻
6+
7+
Make sure you have all of the following prerequisites installed on your
8+
development machine:
9+
10+
* Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux
11+
machines typically have this already installed.
12+
* Hugo - [Download & Install
13+
Hugo](https://gohugo.io/getting-started/installing/). The Hugo framework can
14+
typically be installed by the package manager of your choice.
15+
16+
## Getting started :runner:
17+
18+
To run the website locally use following commands:
19+
20+
```
21+
git clone --recurse-submodules https://github.com/knoxite/website.git
22+
cd website
23+
hugo serve -D
24+
```
25+
26+
After running these commands the server will wait for incoming connections at
27+
your **localhost**. As soon as you edit the content of the blogs configs or
28+
markdown posts the server will live-reload the changes.
29+
30+
## Further References :book:
31+
32+
* Hugo [website](https://gohugo.io), [quick
33+
start](https://gohugo.io/getting-started/quick-start/) guide and
34+
[documentation](https://gohugo.io/documentation/).
35+
* The [syna](https://git.okkur.org/syna) theme used for this website

0 commit comments

Comments
 (0)