Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.83 KB

README.md

File metadata and controls

32 lines (19 loc) · 1.83 KB
Raw

Build Status

Allusion

Allusion is a tool built for artists, aimed to help you organize your Visual Library – A single place that contains your entire collection of references, inspiration and any other kinds of images.

Read more about Allusion →

Installation

Find the latest version of Allusion on the Releases page. The application can be automatically updated when a new version becomes available.

Development

Quick Start

You need to have NodeJS and a package manager such as Yarn installed. Then run the following commands to get started:

  1. Run yarn install to install or update all necessary dependencies.
  2. Run yarn dev to build the project files to the /build directory. This will keep running to immediately build changed files when they are updated.
  3. In a second terminal, run yarn start to start the application. Refresh the window (Ctrl/Cmd + R) after modifying a file to load the updated build files.

Release Build

An installable executable can be built using yarn package for your platform in the /dist folder. The building is performed using the electron-builder package, and is configured by a section in the package.json file. Builds are automatically published to Github Releases when a tag is created in GitHub.

Further Information

Anything related from documentation to frequently asked questions can be found in our wiki.