Skip to main content

Getting Started

Installation

Add Toucaan to your project, like so:

at/your/project/root/
git submodule add https://github.com/Toucaan/toucaan

The command above will install Toucaan to your project like a git submodule1. That's it. Now you can start implementing your application's multiple frontends with Toucaan.

Go to the next step and configure your HTML to start using Toucaan.


Not using git? Set up Toucaan manually (DIY) with just a few commands and use it with any version control system you like.

tip

Review the Architecture of Toucaan and glance through the core concepts quickly.

Inline Documentation

Toucaan's sourcecode is also documented in-line. Contributions and improvements are very welcome.

caution

This is a partially stable version of Toucaan (0.5.0). Our documentation and tooling is in the state of flux and a few breaking changes in the next few weeks are likely.


  1. Please add and commit the .gitmodules file to your repository. Refer the following guide on how to use git submodules to manage packages in your project.