Skip to content
📚 Understand, don't memorize.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archetypes
assets
content/post
etc
favicon
layouts
maint
redirects
scripts
styles
tex
themes
.flake8
.gitignore
.gitmodules
.travis.yml
LICENSE.md
Pipfile
Pipfile.lock
README.md
SConstruct
config.toml

README.md

Intuitive Explanations

My personal website!

Dependencies

  • Git (to obtain and contribute to the code)
  • Python 2 (to run SCons)
  • Pipenv (to install the Python dependencies)
  • SCons (to build the project)
  • LaTeX (to render the TeX files to PDFs)
  • GIMP (to render the XCF files to PNGs)
  • Hugo (to build the website)

Installation on macOS

Install the command-line tools:

$ xcode-select --install

Install Homebrew:

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install Python 2 from Homebrew:

$ brew install python

Set up a virtual environment:

$ pipenv install --two

Install SCons:

$ brew install scons

Install TeX Live:

$ brew cask install mactex

Install GIMP:

$ brew cask install gimp
$ cd /Applications/GIMP-2.10.app/Contents/MacOS
$ ln python python2
$ cat > ~/.local/bin/gimp <<"EOF"
#!/bin/sh
/Applications/GIMP-2.10.app/Contents/MacOS/gimp "$@"
EOF

Install Hugo:

$ brew install hugo

Development

Clone the repo:

$ git clone --recursive https://github.com/raxod502/intuitive-explanations.git
$ cd intuitive-explanations

Build the website:

$ pipenv run scons

Run the development server (this will live-reload changes to the primary content of the website, although not changes to the favicons, redirects, or LaTeX):

$ hugo server

Clean build artifacts:

$ pipenv run scons -c

Build and deploy to Netlify:

$ pipenv run scons deploy

Check out the Travis build.

You can’t perform that action at this time.