Skip to content

Commit 2f80428

Browse files
authored
Better readme (#1)
* Improve README by adding image and better description * Change H4 to H3 * Remove bold parts
1 parent f9e49a2 commit 2f80428

2 files changed

Lines changed: 48 additions & 34 deletions

File tree

README.md

Lines changed: 48 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,70 @@
1-
# otype.de
1+
<p align="center">
2+
<img src="/images/otype_site.png" alt="otype Site"/>
3+
</p>
4+
5+
<p>
6+
<a href="https://github.com/otype/otype.github.io/commits/master">
7+
<img src="https://img.shields.io/github/last-commit/otype/otype.github.io.svg?style=flat-square&logo=github&logoColor=white" alt="GitHub last commit">
8+
<a href="https://github.com/otype/otype.github.io/issues">
9+
<img src="https://img.shields.io/github/issues-raw/otype/otype.github.io.svg?style=flat-square&logo=github&logoColor=white" alt="GitHub issues">
10+
<a href="https://github.com/otype/otype.github.io/pulls">
11+
<img src="https://img.shields.io/github/issues-pr-raw/otype/otype.github.io.svg?style=flat-square&logo=github&logoColor=white" alt="GitHub pull requests">
12+
</p>
13+
14+
This repository contains all files for my sites (identical copies):
15+
16+
- [otype.github.io](https://otype.github.io)
17+
- [otype.de](https://otype.de)
218

3-
This repository contains all files for my site [otype.github.io](https://otype.github.io) and [otype.de](https://otype.de). The site is based on [Hugo](https://gohugo.io/).
19+
The site is based on [Hugo](https://gohugo.io/) and the [hugo-goa](https://github.com/kaapiandcode/hugo-goa) theme.
420

5-
## Running locally
21+
## Getting started
622

7-
1. Clone this repo (assumes you are using [gh](https://cli.github.com/)):
8-
```
9-
gh repo clone otype/otype.de
10-
```
23+
### Requirements
1124

12-
2. Run setup:
25+
- [Golang](https://go.dev/), installed e.g. via [goenv](https://github.com/syndbg/goenv)
26+
- [Hugo](https://gohugo.io/)
27+
- [gh](https://cli.github.com/)
1328

29+
### Development setup
30+
31+
1. Clone this repo.
32+
```console
33+
$ gh repo clone otype/otype.github.io
1434
```
15-
make setup
35+
36+
2. Run setup.
37+
38+
```console
39+
$ make setup
1640
````
1741

18-
3. Run server:
42+
3. Run server.
1943

44+
```console
45+
$ make run
2046
```
21-
make run
22-
```
23-
24-
## Release and deploy
2547

26-
This will deploy to:
27-
- [otype.github.io](https://otype.github.io) and
28-
- [otype.de](https://otype.de)
48+
### Release and deploy a new version
2949

30-
Assumption:
31-
You have made all changes and pushed to `main`.
50+
1. Commit and push all changes to `main`.
3251

33-
Build the site:
52+
2. Build the site. Default `Makefile` target will run `hugo`.
3453

35-
```
36-
make
54+
```console
55+
$ make
3756
```
3857

39-
Now, create a release (pick a new tag version):
58+
3. Create a release. Pick a new `tag` version. If unclear check the existing [tags](https://github.com/otype/otype.github.io/tags) in this repository.
4059

41-
E.g.
42-
```
43-
gh release create v1.2 --generate-notes
60+
```console
61+
$ gh release create v1.2 --generate-notes
4462
```
4563

46-
Then, deploy:
64+
4. Deploy. This automatically updates [otype.github.io](https://otype.github.io) and copies all files to [otype.de](https://otype.de).
4765

48-
```
49-
make deploy
66+
```console
67+
$ make deploy
5068
```
5169

52-
Deploy will implicitly ...
53-
- checkout branch `public`,
54-
- rebase `main`,
55-
- push to `public`
56-
- and `scp` all files to Uberspace.
70+
The Makefile `deploy` target will implicitly checkout branch `public`, rebase `main`, push to `public` and `scp` all files to Uberspace.

images/otype_site.png

131 KB
Loading

0 commit comments

Comments
 (0)