From cefad0dcf0b1f8feac1b54ba60693a7948a12b55 Mon Sep 17 00:00:00 2001
From: Hasan al Rasyid <hasanalrasyid@home>
Date: Wed, 23 Mar 2022 18:32:40 +0900
Subject: [PATCH] add readme

---
 Makefile  |  2 +-
 README.md | 17 +++++++++++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/Makefile b/Makefile
index ab6edb1..8afcd93 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,3 @@
 article:
 	rm -rf _build/auto
-	GHC_PACKAGE_PATH=${HOME}/Documents/kerja/devKit/pubsEngine/.stack-work/install/x86_64-linux-tinfo6/3d751d21e6b97977106d82e2ec3961638329963dd4d98bc4115204782f5d4168/8.10.7/pkgdb:${HOME}/.stack/snapshots/x86_64-linux-tinfo6/3d751d21e6b97977106d82e2ec3961638329963dd4d98bc4115204782f5d4168/8.10.7/pkgdb:${GHC_PACKAGE_PATH} pubsEngine manuscript article
+	GHC_PACKAGE_PATH=${PUBSENGINE_ROOT}/.stack-work/install/x86_64-linux-tinfo6/3d751d21e6b97977106d82e2ec3961638329963dd4d98bc4115204782f5d4168/8.10.7/pkgdb:${HOME}/.stack/snapshots/x86_64-linux-tinfo6/3d751d21e6b97977106d82e2ec3961638329963dd4d98bc4115204782f5d4168/8.10.7/pkgdb:${GHC_PACKAGE_PATH} pubsEngine manuscript article
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8cc1ed2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# pubsEngine-template
+
+This repository is a Proof of Works (POW) for `pubsEngine`.
+It also stands as a scaffolding for a manuscript project.
+
+# Usage
+
+Just `make` it.
+
+By default, `make` will produce `_build/manuscript.pdf`.
+This document will be built under `article` template.
+
+To make your own project, just edit `manuscript.md`.
+All other files will be following this main document.
+All results will be collected inside `_build/`.
+
+All issues should be addressed to the main project issues tracker at [pubsEngine](https://github.com/hasanalrasyid/pubsengine/issues).