Skip to content

phuang1024/csanim

Repository files navigation

CS Animation

A tool for creating computer science explanatory videos.

Inspired by 3Blue1Brown.

Documentation

Installation

Please see the docs page.

Building

Module

# Install Python packages
pip install -r requirements.txt

# Build the C++ sources.
make cpp

# Next, build the wheel file.
make wheel

# Last (optional), install the wheel file.
make install

Docs

# The documentation uses sphinx autodoc, which depends
# on the module. Follow above instructions to build and
# install the module first.

# Install Python packages
pip install sphinx sphinx_rtd_theme

# Build docs with sphinx
make docs

# Open in a browser
firefox ./docs/_build/html/index.html