From 860860f343967e790c0faf64d148c2fd789592a6 Mon Sep 17 00:00:00 2001 From: Dimitar Trendafilov Date: Mon, 3 Sep 2018 21:31:23 +0300 Subject: Added README --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..66d884f --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Implementation of Programming Languages + +This is the code of the website of a course on implementing a programming +language. The website is hosted at https://sofiacpp.github.io/IPL. + +## Working with the website + +The website is deployed as GitHub pages from the contents of the gh-pages branch +of this repository. + + +### Requirements + +- Git and Git-Bash on Windows +- [hugo](https://gohugo.io) + +### Checking out the code + +Simply clone this repository. + +### Setting up the clone + +1. Make sure that `git` and `hugo` are in the path +2. Add the gh-pages as a *git worktree* under the public folder + + +### Creating new content + +#### Creating new posts + +The normal hugo way of creating new posts applies + + hugo new content/posts/post.md + hugo new content/page/page.md + +Creating new slides requires using a different template. You can use the +*content/slides* as boilerplate. + + cp -R content/slides content/myslides + edit content/myslides/_index.md + +### Publishing changes + +1. Make any changes to the content and **COMMIT** +2. Run the publish.sh script + + sh publish.sh + + It will generate the new version inside the *public* folder, commit and push + it. -- cgit v1.3.1-26-gb76a