{"id":13432781,"url":"https://github.com/prikhi/pencil","last_synced_at":"2025-10-29T10:30:38.218Z","repository":{"id":28590729,"uuid":"32108905","full_name":"prikhi/pencil","owner":"prikhi","description":"DEPRECATED: Multiplatform GUI Prototyping/Wireframing","archived":true,"fork":false,"pushed_at":"2018-09-19T00:12:34.000Z","size":7464,"stargazers_count":1922,"open_issues_count":577,"forks_count":193,"subscribers_count":126,"default_branch":"develop","last_synced_at":"2024-10-11T23:22:14.447Z","etag":null,"topics":["firefox-extension","pencil","prototyping","wireframing","xulrunner"],"latest_commit_sha":null,"homepage":"https://github.com/evolus/pencil","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prikhi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-12T23:26:58.000Z","updated_at":"2024-10-03T11:04:43.000Z","dependencies_parsed_at":"2022-09-03T17:31:02.159Z","dependency_job_id":null,"html_url":"https://github.com/prikhi/pencil","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prikhi%2Fpencil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prikhi%2Fpencil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prikhi%2Fpencil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prikhi%2Fpencil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prikhi","download_url":"https://codeload.github.com/prikhi/pencil/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238803531,"owners_count":19533332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["firefox-extension","pencil","prototyping","wireframing","xulrunner"],"created_at":"2024-07-31T02:01:16.484Z","updated_at":"2025-10-29T10:30:37.281Z","avatar_url":"https://github.com/prikhi.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Pencil\n\n**Download Pencil from [Github][releases] or [Mozilla][amo-pkg]**\n\n**Checkout [Pencil v3][pencil3] from Evolus - But Backup Your Data First!**\n\n[![Documentation Status](https://readthedocs.org/projects/pencil-prototyping/badge/?version=develop)](https://readthedocs.org/projects/pencil-prototyping/?badge=develop)\n[![Join the chat at https://gitter.im/prikhi/pencil](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/prikhi/pencil?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nA GUI prototyping tool for Firefox, GNU/Linux, OS X \u0026 Windows.\n\n![Screenshot][screenshot]\n\n### Status\n\n#### [Pencil v3][pencil3] is in development by Evolus, future work on this fork will be minimal.\n#### Pencil v3 files are not backwards compatible, be sure to backup your data!\n\nThis project was originally hosted on https://code.google.com/p/evoluspencil/ \u0026\nwas abandoned around 2013. This fork was started for new development on March\n13th, 2015.\n\n### Links\n\n* [The documentation][docs]\n* [The discussion forum][google-group]\n* [The original project's homepage][evolus-page]\n* [The original repository][evolus-repo]\n* [Downloads][releases]\n\n#### Extra Stencil Collections\n\n* [Android Lollipop][lollipop-collection] by [Nathanielw][nathanielw]\n* [Bootstrap][bootstrap-collection] by [Nathanielw][nathanielw]\n* [Bootstrap Glyph Icons][bootstrap-icon-collection] by [Craig-Fisk][craigfisk]\n* [Material Design Icons][material-collection] by [Nathanielw][nathanielw]\n* [Polymer Iron Icons][iron-icons-collection] by [MercMobily][mercmobily]\n\nAdditional collections are available on the\n[Original Stencil Download Page][evolus-stencil-downloads].\n\n### Known Issues\n\n* The Native UI Stencil Collection does not load or export correctly, you\n  should avoid using this Stencil Collection for now(see #602).\n* Dragging stencils onto the workspace does not work in newer version of\n  Firefox, either use Pale Moon, Xulrunner, an older version of Firefox, or\n  launch Pencil using `firefox --app /path/to/application.ini` (see #802).\n\n## Prerequisites\n\nYou will need version 4 or higher of [`firefox`][firefox] to run Pencil as a\nFirefox Extension. Linux users will need version 4 or higher of either `firefox`,\n`iceweasel` or [`xulrunner`][xulrunner], or version 25 or higher of\n[`palemoon`][palemoon]. The Windows installer and OS X archive\nhas everything you need built-in.\n\n\n## Install\n\nWindows, Linux, OS X \u0026 Firefox Packages are available for download from the\n[Releases Page][releases].\n\nYou can also install the Firefox Add-on from the [Mozilla Add-on\nRepository][amo-pkg].\n\nTo install the OS X package, unzip the archive and copy the `Pencil.app` folder\nto your `Applications` directory.\n\nFor specific Linux distributions:\n* **Arch Linux** - Available in the [AUR][aur-pkg].\n* **Nix/NixOS** - Run `nix-env -iA pencil`. You'll need to be tracking\n  [Unstable][nix-unstable].\n* **openSUSE** - Available in the [graphics repository][graphics-repository].\n* **Ubuntu** - A .deb is available on the [Releases Page][releases].\n\n## Build\n\n### Firefox Extension\n\nPencil can be installed as Firefox Extension, instead of a standalone\napplication. To build the extension's `XPI` file:\n```bash\n\ncd build\n./build.sh xpi\nfirefox Outputs/Pencil*.xpi\n```\n\n### Linux\n```bash\n\ncd build\n./build.sh linux\nxulrunner Outputs/Linux/application.ini || firefox --app Outputs/Linux/application.ini\n```\n\nA `Pencil-*-linux-pkg.tar.gz` package will also be created. This contains\nPencil nested within the directory structure that most Linux distributions\nexpect(under `/usr/share` and `/usr/bin`) along with an executable, a desktop\nentry \u0026 mimetype information. This can be used for creating\ndistribution-specific packages.\n\n### Windows\n\nYou'll need `curl` installed so you can pull the Windows XULRunner runtime and\n[NSIS][nsis] to compile the installer.\n\n```bash\n\ncd build\n./build.sh win32\n```\n\nThis should place an installer `exe` in the `Outputs/` folder.\n\n### OS X\n\nYou'll need `curl` installed to fetch the OS X XULRunner runtime.\n\n```bash\n\ncd build\n./build.sh mac\n```\n\nThis will create a `Pencil.app` folder in `Outputs/Mac` and a compressed\nversion in `Outputs/`.\n\n### Documentation\n\nTo build the docs locally you'll need [`Sphinx`][sphinx-doc] along with some\nplugins, which are easily installable using Python's [pip][pip] installer:\n\n\n```bash\ncd docs/\nsudo pip install -r requirements.txt\nmake html\n# Or if you want a PDF\nmake latexpdf\n```\n\nThe output files will be put in `/docs/build/`.\n\n\n## Contribute\n\nYou don't have to be a programmer to contribute! All feature requests \u0026 bug\nreports are appreciated.\n\n### Users\n* **File Bugs** and Feature Requests. If you are unsure how to do this, read\n  [\"Writing Good Bug Reports\"][writing-bugs].\n* **Reproduce Bugs** – there are many issues which have not been confirmed since\n  they were migrated from the original project. Try to reproduce the bug and\n  state in a comment if you could reproduce it or not.  State your operating\n  system and Pencil version ([example bug][example-bug]).\n* **Report Duplicate Bugs** - lots of imported bugs are duplicates and simply add\n  noise to the issue tracker. If you notice a duplicate issue, please leave a\n  comment on the issue \u0026 mention the issue that you think it duplicates.\n* **Improve the [Documentation][docs]**. The files are in the `docs` folder and\n  written in [reStructuredText][rst-quickref].\n* **Just spread the word** :)\n\n### Technical Users\n* **Package Pencil** for your distribution or OS.\n* **Create a Stencil** Collection for your favorite UI framework or improve\n  Pencil's default offering, as described in the\n  [Stencil Developer Documentation][stencil-dev-docs].\n\n### Developers\n* **There are many bugs to fix** – if you could tackle one or two that would be\ngreat! The most important bugs have a [Critical label][critical-issues]. The\n`stars` labels are a heritage of the old google code repository: Many stars =\nmany people interested in the bug or feature. You can also check the\n[Milestones][milestones] for issues to tackle.\n* **Commenting and documenting** code to ease the programming for others – most\n  of it is currently without comments and having them would help much.\n\nIf you make changes that affect users, please update `CHANGELOG.md`.\n\nFor lots more information on getting started developing on Pencil, check out\nthe [Developer's Documentation][dev-docs].\n\n\n## License\n\nThis fork is released under GPLv2 like it's parent codebase.\n\n\n[screenshot]: http://i.imgur.com/DF715Nr.png\n[pencil3]: https://github.com/evolus/pencil/\n[docs]: http://pencil-prototyping.rtfd.org/\n[google-group]: https://groups.google.com/forum/#!forum/pencil-user\n[evolus-page]: http://pencil.evolus.vn/\n[evolus-repo]: https://code.google.com/p/evoluspencil/\n[evolus-stencil-downloads]: https://code.google.com/p/evoluspencil/downloads/list?q=label:Stencil\n\n[firefox]: https://www.mozilla.org/firefox/\n[xulrunner]: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/XULRunner\n[palemoon]: https://www.palemoon.org/\n\n[releases]: https://github.com/prikhi/pencil/releases\n[amo-pkg]: https://addons.mozilla.org/en-US/firefox/addon/pencil-prototyping/\n[aur-pkg]: https://aur.archlinux.org/packages/pencil-v2/\n[nix-unstable]: https://nixos.org/nixos/manual/sec-upgrading.html\n[graphics-repository]: https://software.opensuse.org/package/pencil\n\n[nathanielw]: https://github.com/nathanielw\n[lollipop-collection]: https://github.com/nathanielw/Android-Lollipop-Pencil-Stencils\n[material-collection]: https://github.com/nathanielw/Material-Icons-for-Pencil\n[bootstrap-collection]: https://github.com/nathanielw/Bootstrap-Pencil-Stencils\n[bootstrap-icon-collection]: https://github.com/Craig-Fisk/BootstrapGlyph-Pencil-Stencil\n[craigfisk]: https://github.com/Craig-Fisk\n[iron-icons-collection]: https://github.com/mercmobily/pencil-iron-icons\n[mercmobily]: https://github.com/mercmobily\n\n[nsis]: http://nsis.sourceforge.net/Main_Page\n[sphinx-doc]: http://sphinx-doc.org/\n[pip]: https://pip.pypa.io/\n[writing-bugs]: http://www.lee-dohm.com/2015/01/04/writing-good-bug-reports.html\n[example-bug]: https://github.com/prikhi/pencil/issues/640\n[rst-quickref]: http://docutils.sourceforge.net/docs/user/rst/quickref.html\n[stencil-dev-docs]: https://pencil-prototyping.readthedocs.org/en/develop/stencil-dev/\n\n[critical-issues]: https://github.com/prikhi/pencil/labels/Priority-Critical\n[milestones]: https://github.com/prikhi/pencil/milestones?state=open\n[dev-docs]: https://pencil-prototyping.readthedocs.org/en/develop/developers/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprikhi%2Fpencil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprikhi%2Fpencil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprikhi%2Fpencil/lists"}