From 91e25b7a821a714252a067479c38742c34f3db48 Mon Sep 17 00:00:00 2001 From: Author <> Date: Sat, 26 Aug 2023 14:31:39 -0400 Subject: [PATCH] Added README file --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b7efb69 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +This repository contains the code for my personal site, hosted at [carya.software](https://www.carya.software). + +# Building +"building" the site such that it can be deployed is simple. Add the two custom fonts used to the fonts folder, and compile the tailwindCSS. +## Fonts +Obtain the files [ioseevka_ter_regular.ttf](https://typeof.net/Iosevka/) and [OFLGoudyStMTT.ttf](https://www.1001fonts.com/ofl-sorts-mill-goudy-font.html) and put them in the fonts folder. +## Tailwind +[Install TailwindCSS](https://tailwindcss.com/docs/installation) (site most recently built with v3.3.3) with npm if you haven't already. Compile the CSS with the following terminal command. + + npx tailwindcss -i ./www/css/theme.css -o ./www/css/theme-compiled.css