aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75bb848
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# The Markdown Resume
+
+Forked from [nmattia/resume](https://github.com/nmattia/resume)
+
+### Tweak
+
+``` shell
+$ git clone https://github.com/fuwn/resume
+$ cd resume
+$ vim markdown/resume.md # insert your own resume info
+```
+
+### Build
+
+``` shell
+$ nix-build
+```
+
+or
+
+``` shell
+$ nix-shell
+[nix-shell]$ make
+```
+
+### Requirements
+
+ * ConTeXt
+ * pandoc
+ * GNU make
+
+The requirements can be provided by the nix-shell.