You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Duong Thanh An e7f2c1bc52 Add 3.1.1 release notes 3 months ago
RELEASE Add 3.1.1 release notes 3 months ago
app Fix shared property page wrong content when switching document 3 months ago
.buildignore added grunt build tool. 7 years ago
.editorconfig added grunt build tool. 7 years ago
.gitattributes added grunt build tool. 7 years ago
.gitignore upgrade electron to 1.4.14 6 years ago
.gitlab-ci.yml added ci build for Mac. 7 years ago
.project Initial import 7 years ago
.travis.yml added support for linux i386. 6 years ago added issue template. 7 years ago fixed invalid app information on Windows 7 years ago Update readme for development 4 years ago
appveyor.yml Update version to 3.0.4 6 years ago
package-lock.json Add support for free hand drawing 3 months ago
package.json Use arm64 as mac arch 3 months ago
screenshot.png added screenshot + supported platforms 7 years ago
yarn.lock Add support for free hand drawing 3 months ago

Image of Yaktocat

About The Next Version

Pencil V3 is a rewrite of Pencil that aims to fix major performance and scalability issues of the application. The new version is under heavy development and we are expecting GA builds in June. The following list summarizes important changes in the new version:

  • Pencil V3 uses Electron instead of Mozilla XULRunner as the runtime. We expect that by moving into this Nodejs-based environment, the Pencil source code can be much easier for all fellow developers to play with. The fact that Mozilla XULRunner is outdated is also a reason for the movement.
  • A new, zip-based file format was introduced to support large documents and better embedding of external bitmaps/resources.
  • A new mechanism for page management that dramatically reduces memory usage for large documents.
  • Document pages can now be structured into a tree-like model.
  • Custom fonts can now be embedded into Pencil .epz documents
  • Printing and PDF export will be improved to support all platforms and with many options
  • New UI approach

Setting up

Pencil uses Atom Electron as the runtime, follow the these steps to setup the environment:

  • Clone this repository

  • Make sure you are using nodejs 5+ (Pencil development only needs npm for package management. Node runtime is not required.)

  • Checkout this development branch:

    $ git checkout development
  • Install dependencies:

    $ npm install
  • Start Pencil using the prebuilt version of Electron

      $ npm start

Supported Platforms


Only OSX 64bit 10.9 and later are supported.


Windows 7 and later are supported, older operating systems are not supported (and do not work).