README.md (1587B) - raw


      1 # Personal website
      2 
      3 This repository is the source code for my [personal website][pw]. The site is
      4 generated by `gensite.py`, a program based on [makesite.py][ms] (which is a very
      5 bare-bones static site generator).
      6 
      7 ## Dependencies
      8 
      9 To generate the site all you need is Python 3 and the markdown library (install
     10 with `pip3 install markdown`).
     11 
     12 ## Other notes
     13 
     14 The font used for the logo is "Libre Baskerville" in bold. The `woff2` file used
     15 for the font only includes the needed letters for the logo ("BOacdeinorst") to
     16 keep the file size small (2.5 KiB). To create such file, you can use the
     17 following command:
     18 
     19 ```sh
     20 pyftsubset LibreBaskerville-Bold.ttf \
     21   --unicodes=U+004F,U+0073,U+0063,U+0061,U+0072,U+0042,U+0065,U+006E,U+0064,U+0069,U+0074,U+006F \
     22   --output-file=<output-font-file>.woff2 --flavor=woff2
     23 ```
     24 
     25 You might need to run `pip3 install fonttools brotli` to install the
     26 dependencies.
     27 
     28 ## License
     29 
     30 The contents of this repositories are licensed under the [GNU Affero General
     31 Public License version 3][agpl] or (at your option) any later version.
     32 
     33 More specifically, the contents of my pages (in the contents folder) are
     34 licensed under the [Creative Commons Attribution 4.0 International
     35 License][cc-by].
     36 
     37 [pw]: <https://oscarbenedito.com> "Oscar Benedito's personal website"
     38 [ms]: <https://github.com/sunainapai/makesite> "makesite by Sunaina Pai — GitHub"
     39 [agpl]: <https://www.gnu.org/licenses/agpl-3.0.html> "GNU Affero General Public License version 3"
     40 [cc-by]: <https://creativecommons.org/licenses/by/4.0/> "Creative Commons Attribution 4.0 International License"