aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-05-07 17:49:09 -0700
committerFuwn <[email protected]>2021-05-07 17:49:09 -0700
commit4fd1acb3420a9fa337bc5ac738b0fe859873fe2d (patch)
tree47d3e8f2e2a75fab8b216fb3c3d9acaa10d62885 /README.md
parentfix(actions): use correct version of install-nix-action (diff)
downloadresume-md-4fd1acb3420a9fa337bc5ac738b0fe859873fe2d.tar.xz
resume-md-4fd1acb3420a9fa337bc5ac738b0fe859873fe2d.zip
refactor(readme): spice it up
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 10 insertions, 16 deletions
diff --git a/README.md b/README.md
index 75bb848..b4634a6 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,26 @@
-# The Markdown Resume
+# 📝 Resume
-Forked from [nmattia/resume](https://github.com/nmattia/resume)
-
-### Tweak
+Forked from [nmattia/resume](https://github.com/nmattia/resume).
+## Tweaking
``` shell
$ git clone https://github.com/fuwn/resume
$ cd resume
-$ vim markdown/resume.md # insert your own resume info
+$ vim markdown/resume.md # Modify to fit your own needs.
```
-### Build
+## Building
+
+### Requirements (if you DON'T use `nix-shell`)
+* ConTeXt
+* [pandoc](https://pandoc.org/)
+* [GNU make](https://www.gnu.org/software/make/)
``` shell
$ nix-build
```
-
or
-
``` shell
$ nix-shell
[nix-shell]$ make
```
-
-### Requirements
-
- * ConTeXt
- * pandoc
- * GNU make
-
-The requirements can be provided by the nix-shell.