Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prikhi/pencil

DEPRECATED: Multiplatform GUI Prototyping/Wireframing
https://github.com/prikhi/pencil

firefox-extension pencil prototyping wireframing xulrunner

Last synced: about 2 months ago
JSON representation

DEPRECATED: Multiplatform GUI Prototyping/Wireframing

Awesome Lists containing this project

README 

        
# Pencil



**Download Pencil from [Github][releases] or [Mozilla][amo-pkg]**



**Checkout [Pencil v3][pencil3] from Evolus - But Backup Your Data First!**



[![Documentation Status](https://readthedocs.org/projects/pencil-prototyping/badge/?version=develop)](https://readthedocs.org/projects/pencil-prototyping/?badge=develop)

[![Join the chat at https://gitter.im/prikhi/pencil](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/prikhi/pencil?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



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



![Screenshot][screenshot]



### Status



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

#### Pencil v3 files are not backwards compatible, be sure to backup your data!



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



* [The documentation][docs]

* [The discussion forum][google-group]

* [The original project's homepage][evolus-page]

* [The original repository][evolus-repo]

* [Downloads][releases]



#### Extra Stencil Collections



* [Android Lollipop][lollipop-collection] by [Nathanielw][nathanielw]

* [Bootstrap][bootstrap-collection] by [Nathanielw][nathanielw]

* [Bootstrap Glyph Icons][bootstrap-icon-collection] by [Craig-Fisk][craigfisk]

* [Material Design Icons][material-collection] by [Nathanielw][nathanielw]

* [Polymer Iron Icons][iron-icons-collection] by [MercMobily][mercmobily]



Additional collections are available on the

[Original Stencil Download Page][evolus-stencil-downloads].



### Known Issues



* The Native UI Stencil Collection does not load or export correctly, you

  should avoid using this Stencil Collection for now(see #602).

* Dragging stencils onto the workspace does not work in newer version of

  Firefox, either use Pale Moon, Xulrunner, an older version of Firefox, or

  launch Pencil using `firefox --app /path/to/application.ini` (see #802).



## Prerequisites



You will need version 4 or higher of [`firefox`][firefox] to run Pencil as a

Firefox Extension. Linux users will need version 4 or higher of either `firefox`,

`iceweasel` or [`xulrunner`][xulrunner], or version 25 or higher of

[`palemoon`][palemoon]. 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][releases].



You can also install the Firefox Add-on from the [Mozilla Add-on

Repository][amo-pkg].



To install the OS X package, unzip the archive and copy the `Pencil.app` folder

to your `Applications` directory.



For specific Linux distributions:

* **Arch Linux** - Available in the [AUR][aur-pkg].

* **Nix/NixOS** - Run `nix-env -iA pencil`. You'll need to be tracking

  [Unstable][nix-unstable].

* **openSUSE** - Available in the [graphics repository][graphics-repository].

* **Ubuntu** - A .deb is available on the [Releases Page][releases].



## Build



### Firefox Extension



Pencil can be installed as Firefox Extension, instead of a standalone

application. To build the extension's `XPI` file:

```bash



cd build

./build.sh xpi

firefox Outputs/Pencil*.xpi

```



### Linux

```bash



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][nsis] to compile the installer.



```bash



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.



```bash



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`][sphinx-doc] along with some

plugins, which are easily installable using Python's [pip][pip] installer:



```bash

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

* **File Bugs** and Feature Requests. If you are unsure how to do this, read

  ["Writing Good Bug Reports"][writing-bugs].

* **Reproduce Bugs** – there are many issues which have not been confirmed since

  they were migrated from the original project. Try to reproduce the bug and

  state in a comment if you could reproduce it or not.  State your operating

  system and Pencil version ([example bug][example-bug]).

* **Report Duplicate Bugs** - lots of imported bugs are duplicates and simply add

  noise to the issue tracker. If you notice a duplicate issue, please leave a

  comment on the issue & mention the issue that you think it duplicates.

* **Improve the [Documentation][docs]**. The files are in the `docs` folder and

  written in [reStructuredText][rst-quickref].

* **Just spread the word** :)



### Technical Users

* **Package Pencil** for your distribution or OS.

* **Create a Stencil** Collection for your favorite UI framework or improve

  Pencil's default offering, as described in the

  [Stencil Developer Documentation][stencil-dev-docs].



### Developers

* **There are many bugs to fix** – if you could tackle one or two that would be

great! The most important bugs have a [Critical label][critical-issues]. The

`stars` labels are a heritage of the old google code repository: Many stars =

many people interested in the bug or feature. You can also check the

[Milestones][milestones] for issues to tackle.

* **Commenting and documenting** code to ease the programming for others – most

  of it is currently without comments and having them would help much.



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][dev-docs].



## License



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



[screenshot]: http://i.imgur.com/DF715Nr.png

[pencil3]: https://github.com/evolus/pencil/

[docs]: http://pencil-prototyping.rtfd.org/

[google-group]: https://groups.google.com/forum/#!forum/pencil-user

[evolus-page]: http://pencil.evolus.vn/

[evolus-repo]: https://code.google.com/p/evoluspencil/

[evolus-stencil-downloads]: https://code.google.com/p/evoluspencil/downloads/list?q=label:Stencil



[firefox]: https://www.mozilla.org/firefox/

[xulrunner]: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/XULRunner

[palemoon]: https://www.palemoon.org/



[releases]: https://github.com/prikhi/pencil/releases

[amo-pkg]: https://addons.mozilla.org/en-US/firefox/addon/pencil-prototyping/

[aur-pkg]: https://aur.archlinux.org/packages/pencil-v2/

[nix-unstable]: https://nixos.org/nixos/manual/sec-upgrading.html

[graphics-repository]: https://software.opensuse.org/package/pencil



[nathanielw]: https://github.com/nathanielw

[lollipop-collection]: https://github.com/nathanielw/Android-Lollipop-Pencil-Stencils

[material-collection]: https://github.com/nathanielw/Material-Icons-for-Pencil

[bootstrap-collection]: https://github.com/nathanielw/Bootstrap-Pencil-Stencils

[bootstrap-icon-collection]: https://github.com/Craig-Fisk/BootstrapGlyph-Pencil-Stencil

[craigfisk]: https://github.com/Craig-Fisk

[iron-icons-collection]: https://github.com/mercmobily/pencil-iron-icons

[mercmobily]: https://github.com/mercmobily



[nsis]: http://nsis.sourceforge.net/Main_Page

[sphinx-doc]: http://sphinx-doc.org/

[pip]: https://pip.pypa.io/

[writing-bugs]: http://www.lee-dohm.com/2015/01/04/writing-good-bug-reports.html

[example-bug]: https://github.com/prikhi/pencil/issues/640

[rst-quickref]: http://docutils.sourceforge.net/docs/user/rst/quickref.html

[stencil-dev-docs]: https://pencil-prototyping.readthedocs.org/en/develop/stencil-dev/



[critical-issues]: https://github.com/prikhi/pencil/labels/Priority-Critical

[milestones]: https://github.com/prikhi/pencil/milestones?state=open

[dev-docs]: https://pencil-prototyping.readthedocs.org/en/develop/developers/