Home

Awesome

Mirage Build Status

Demo

Install

Stable version

To install the stable version, you can simply use the Catalog browser and search for 'WindowsPreviewer' or evaluate the following code snippet:

Pharo 6.1

Metacello new
    repository: 'github://JulienDelplanque/Mirage:v1.0.0/src';
    baseline: 'Mirage';
    load

Pharo 7.x

Metacello new
    repository: 'github://JulienDelplanque/Mirage:v2.1.0/src';
    baseline: 'Mirage';
    load

Development version (Pharo 8.0)

Simply evaluate the following code snippet:

Metacello new
    repository: 'github://JulienDelplanque/Mirage:dev/src';
    baseline: 'Mirage';
    load

Version management

This project use semantic versionning to define the releases. This mean that each stable release of the project will get associate a version number of the form vX.Y.Z.

When a release contains only bug fixes, the patch number increase. When the release contains new features backward compatibles, the minor version increase. When the release contains breaking changes, the major version increase.

Thus, it should be safe to depend on a fixed major version and moving minor version of this project.

Setup

Go to the 'Settings browser' and check the 'Activate' button in 'Mirage' subgroup of 'Tools' group. Then, you can choose the view you want to use by checking the buttons corresponding.

Settings browser

How to use

Once you activated Mirage in the 'Settings browser' hit 'Ctrl+Tab' to open the previewer. You can now use left/right arrow to choose a window and hit the space key to open it.

KeyPurpose
(Ctrl/Shift)+TabOpen the previewer (Ctrl for Linux, Shift for Windows and Mac OS).
Left arrowSelect window on the left of the current window.
Right arrow/TabSelect the window on the right of the current window.
Space/EnterSet the window selected in the previewer on top.
EscQuit the windows previewer without changing the current window.

Developers documentation

The wiki holds all the documentation needed to contribute to the project.

If you want to contribute to this project, please follow the contribution guidelines.

Here are some useful links: