From ec384e8df07e6359cfc91752edacc8b3fe4c7ba9 Mon Sep 17 00:00:00 2001
From: Ismo Vuorinen <11024+ivuorinen@users.noreply.github.com>
Date: Sun, 25 Feb 2024 04:10:24 +0200
Subject: [PATCH] chore: Tweak test-build & readme, add editorconfig (#9)

---
 .editorconfig                    | 14 ++++++++++++++
 .github/README.md                |  6 +++++-
 .github/workflows/test-build.yml | 33 +++++++++++++++++---------------
 3 files changed, 37 insertions(+), 16 deletions(-)
 create mode 100644 .editorconfig

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..8da1429
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 160
+tab_width = 2
+trim_trailing_whitespace = true
+
+[Makefile]
+tab_width = 4
diff --git a/.github/README.md b/.github/README.md
index 0dacac6..b4bf299 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -34,7 +34,11 @@ output: output.md
 Generated by [paperboy](https://github.com/ivuorinen/paperboy)
 ```
 
-The contents is rendered between the two `---` lines.
+The contents are rendered between the two `---` lines.
+
+Then run the binary `paperboy` and the output will be written to the file specified in the `config.yaml` file.
+
+ProTip: Use a cron job to run this weekly and send the output to your email.
 
 ## License
 
diff --git a/.github/workflows/test-build.yml b/.github/workflows/test-build.yml
index a8cab2d..d989005 100644
--- a/.github/workflows/test-build.yml
+++ b/.github/workflows/test-build.yml
@@ -1,25 +1,28 @@
-# This workflow will build a golang project
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
-
-name: Test Build
+---
+name: Test Build and Run
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
-
-  build:
+  test-build-and-run:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Go
-      uses: actions/setup-go@v5
-      with:
-        go-version: '1.22'
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
 
-    - name: Build
-      run: make build
+      - name: Build
+        run: make build
+
+      - name: Setup default template and config
+        run: cp examples/* .
+
+      - name: Run program
+        run: ./paperboy