Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note to Install README.md section #869

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Add note to Install README.md section #869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
56011d5
Update Changelog
prikhi Nov 20, 2016
9dcaa99
Add Info about Bug #802 to Readme
prikhi Nov 22, 2016
ffcd785
Add Iron Icons Stencil Collection Link to README
prikhi Nov 25, 2016
ace1472
Update Version Requirements in README
prikhi Nov 26, 2016
d93d942
[#547] Add Warning About Pencilv3 Backward Incompatiblity
prikhi Feb 26, 2017
6071726
Update Link to Arch Linux AUR Package
prikhi May 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,16 @@ This file describes all user-facing changes, by version.

# v2.0.21

* Fix FF/XUL Max Version.

# v2.0.19

* Add Support for FF/XUL v52.
* Add Support for older versions of FF/XUL(v4+).
* Add French Translation.
* Add Indonesian Translation.
* Fix Debian Packages.

# v2.0.18

* Fix Build.
Expand Down
19 changes: 15 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

**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)

Expand All @@ -12,6 +14,7 @@ A GUI prototyping tool for Firefox, GNU/Linux, OS X & Windows.
### 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
Expand All @@ -31,6 +34,7 @@ was abandoned around 2013. This fork was started for new development on March
* [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].
Expand All @@ -39,12 +43,16 @@ Additional collections are available on the

* 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 36 or higher of [`firefox`][firefox] to run Pencil as a
Firefox Extension. Linux users will need version 36 of either `firefox`,
`iceweasel` or [`xulrunner`][xulrunner]. The Windows installer and OS X archive
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.


Expand Down Expand Up @@ -191,10 +199,11 @@ This fork is released under GPLv2 like it's parent codebase.

[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/
[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

Expand All @@ -204,6 +213,8 @@ This fork is released under GPLv2 like it's parent codebase.
[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/
Expand Down