Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cbraidwood committed Dec 21, 2023
1 parent 5c99b8a commit 3a9c624
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# About

This repository contains files for my personal website. The site is written in Emacs using Org Markdown files, which are then converted to HTML using `org-publish`. The main branch includes the Org files in the `org` directory and the CSS file in the `public` directory. The site is automatically generated using the `build-site.el` script, which saves the converted HTML files into the `public` directory with the existing CSS file. The GitHub Actions script in `.github/workflows` will tell GitHub to generate the site and push to `gh-pages` branch when it detects pushes to `main`. The `gh-pages` branch is where the site is deployed from.

## Building the Site Manually

To manually build the site, just clone the repository and run the included `build.sh` script. The generated site will be placed into the `public` directory.

Here is the command to build:

```bash
$ git clone https://github.com/cbraidwood/website.git && cd website && chmod +x build.sh && ./build.sh
```

0 comments on commit 3a9c624

Please sign in to comment.