Added README file

This commit is contained in:
Author 2023-08-26 14:31:39 -04:00
parent 4ce79257e3
commit 91e25b7a82

10
README.md Normal file
View file

@ -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