Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 1.61 KB

README.md

File metadata and controls

63 lines (45 loc) · 1.61 KB

logo

MIT License

> English < | 简体中文

Introduction

JAnim is a library for simple animation effects.

Inspired by manim.

Installation

⚠️ JAnim does not work on macOS.

JAnim runs on Python 3.12+ and OpenGL 4.3+.

You may install JAnim directly via

pip install janim

to install the latest version distributed on pypi. Or, to catch up with the latest development and edit the source code, you may clone this repository via

git clone https://github.com/jkjkil4/JAnim.git
cd JAnim
pip install -e .

Additionally, there are other software dependencies to be installed:

  • To generate video files, install ffmpeg.
  • To use Typst, install typst.

Using JAnim

You can run the following command to see examples.

janim examples

The Tutorial Page of the Documentation provides a brief view to get you started. (Note: You can change the language of the documentation at the bottom-left corner.)

License

MIT license