Skip to content

Commit

Permalink
nix instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
siph committed May 12, 2023
1 parent 4fd5edc commit 2db5757
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ and deployment.

## Usage


### GitHub

1. Generate a new project using this repository as a template. **Make sure to include all branches!**
2. Enable Read/Write Workflow permissions under `Settings` -> `Actions` for Pages deployment.
3. Edit the `resume.md` file with your resume content using Markdown.
Expand All @@ -24,6 +27,25 @@ the HTML file as a static website.
7. Access your resume as a static website by going to `https://<your-github-username>.github.io/<repository-name>`.


### Local

`Resume-md` uses [`nix`](https://www.nixos.org) to manage all dependencies and
to produce build outputs. As a result, any machine with `nix` installed can run
a simple build command to produce the stylized resumes.
```shell
nix build
```

This will place the stylized files along side the original markdown file in
`result/resume/`:
```shell
 result
└──  resume
├──  resume.html
├──  resume.md
└──  resume.pdf
```

## GitHub Pages

GitHub Pages is used to deploy the stylized HTML file as a static site. For this to work,
Expand Down

0 comments on commit 2db5757

Please sign in to comment.