Home

Awesome

Pencil

Download Pencil from Github or Mozilla

Documentation Status Join the chat at https://gitter.im/prikhi/pencil

A GUI prototyping tool for Firefox, GNU/Linux, OS X & Windows.

Screenshot

Status

Pencil v3 is in development by Evolus, future work on this fork will be minimal.

This project was originally hosted on https://code.google.com/p/evoluspencil/ & was abandoned around 2013. This fork was started for new development on March 13th, 2015.

Links

Extra Stencil Collections

Additional collections are available on the Original Stencil Download Page.

Known Issues

Prerequisites

You will need version 36 or higher of firefox to run Pencil as a Firefox Extension. Linux users will need version 36 of either firefox, iceweasel or xulrunner. The Windows installer and OS X archive has everything you need built-in.

Install

Windows, Linux, OS X & Firefox Packages are available for download from the Releases Page.

You can also install the Firefox Add-on from the Mozilla Add-on Repository.

To install the OS X package, unzip the archive and copy the Pencil.app folder to your Applications directory.

For specific Linux distributions:

Build

Firefox Extension

Pencil can be installed as Firefox Extension, instead of a standalone application. To build the extension's XPI file:


cd build
./build.sh xpi
firefox Outputs/Pencil*.xpi

Linux


cd build
./build.sh linux
xulrunner Outputs/Linux/application.ini || firefox --app Outputs/Linux/application.ini

A Pencil-*-linux-pkg.tar.gz package will also be created. This contains Pencil nested within the directory structure that most Linux distributions expect(under /usr/share and /usr/bin) along with an executable, a desktop entry & mimetype information. This can be used for creating distribution-specific packages.

Windows

You'll need curl installed so you can pull the Windows XULRunner runtime and NSIS to compile the installer.


cd build
./build.sh win32

This should place an installer exe in the Outputs/ folder.

OS X

You'll need curl installed to fetch the OS X XULRunner runtime.


cd build
./build.sh mac

This will create a Pencil.app folder in Outputs/Mac and a compressed version in Outputs/.

Documentation

To build the docs locally you'll need Sphinx along with some plugins, which are easily installable using Python's pip installer:

cd docs/
sudo pip install -r requirements.txt
make html
# Or if you want a PDF
make latexpdf

The output files will be put in /docs/build/.

Contribute

You don't have to be a programmer to contribute! All feature requests & bug reports are appreciated.

Users

Technical Users

Developers

If you make changes that affect users, please update CHANGELOG.md.

For lots more information on getting started developing on Pencil, check out the Developer's Documentation.

License

This fork is released under GPLv2 like it's parent codebase.