Add basic README

This commit is contained in:
timvisee 2019-07-04 13:52:18 +02:00
parent 9ab490a572
commit 10e2710317
No known key found for this signature in database
GPG Key ID: B8DB720BC383E172
2 changed files with 38 additions and 0 deletions

38
README.md Normal file
View File

@ -0,0 +1,38 @@
[![Build and deployment status on GitLab CI][gitlab-ci-master-badge]][gitlab-ci-link]
[gitlab-ci-link]: https://gitlab.com/timvisee/timvisee.com/pipelines
[gitlab-ci-master-badge]: https://gitlab.com/timvisee/timvisee.com/badges/master/pipeline.svg
# timvisee.com
The source code for my personal website.
View it live at [timvisee.com](https://timvisee.com/).
![Homepage screenshot](./screenshot.png)
The majority of the content is formatted in Markdown, located in the
[`content/`](./content/) directory.
It includes a custom theme as well ([zenn][zenn]) for the visuals.
This website is built with [Zola][zola], a static website generator.
See it's documentation for more information on how this project is structured.
Any pull requests for changes on the website are welcome.
To run a local instance of this website, be sure to install [Zola][zola] first.
Then run:
```bash
# Clone the repository
git clone https://gitlab.com/timivsee/timvisee.com
cd timvisee.com
# Build and serve a local instance
zola serve
```
## License
This project is released under the GNU GPL-3.0 license.
Check out the [LICENSE](./LICENSE) file for more information.
[zola]: https://getzola.org./
[zenn]: ./themes/zenn/

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 782 KiB