diff options
author | Nguyễn Gia Phong <mcsinyx@disroot.org> | 2021-03-07 11:58:03 +0700 |
---|---|---|
committer | Nguyễn Gia Phong <mcsinyx@disroot.org> | 2021-03-07 11:58:03 +0700 |
commit | 6a7f3beea1cd4908a03b38064ee49cdb5b2fe14c (patch) | |
tree | b90262387f5f74758df9c46977923ad7dcce0d2f /README.md | |
parent | 3e6f0389f0cdac7b90970c49f455205563b48ad6 (diff) | |
download | site-6a7f3beea1cd4908a03b38064ee49cdb5b2fe14c.tar.gz |
Add repo description and licensing
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..6da16be --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# My personal site + +This is my Franklin-generated static site, *without* client-side scripts. + +## Building + + julia --project=@. .build.jl + +### Explicit dependencies + +The following are needed to run the command above: + +* [Julia](https://julialang.org) +* [pip](https://pip.pypa.io) + +### Implicit dependencies + +The following are installed as part of the build process, +plus their own dependencies: + +* [Franklin](https://franklinjl.org) +* [NodeJS](https://juliapackages.com/p/nodejs) +* [KaTeX](https://katex.org) +* [highlight.js](https://highlightjs.org) +* [css-html-js-minify](https://pypi.org/p/css-html-js-minify) + +## Copying + +[![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)] (https://creativecommons.org/licenses/by-sa/4.0/) +The content of this site is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). |