Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.

Latest commit

 

History

History
53 lines (30 loc) · 1.77 KB

installation-and-usage.md

File metadata and controls

53 lines (30 loc) · 1.77 KB
Raw

Installation and usage

Abricotine is working on Windows (7 and later), Linux and OSX.

Installation

Windows

Download the windows installer from the Releases page and run it.

Also, you can get Abricotine from Scoop:

scoop install abricotine # in extras bucket

OSX

Download OSX prebuilt binaries from the Releases page, extract the archive (if necessary) and run Abricotine.

OSX users can also use Homebrew Cask to install Abricotine: $ brew install --cask abricotine.

Ubuntu, Debian and other Debian-based distributions

Download the provided .deb package from the Releases page and install it.

Other Linux distributions

Download linux prebuilt binaries from the Releases page, extract the archive and run Abricotine.

On Fedora you will also have to install the libXScrnSaver package: yum install libXScrnSaver

Building and packaging

Requirements

Node.js and npm are required.

Building

  1. Install requirements,
  2. Download the latest Abricotine release source and extract the archive,
  3. Run $ npm install in the extracted folder.
  4. You can use Abricotine by running $npm start from its directory. To open a specific file, run $npm start -- [path-to-file].

Packaging

Run $ npm run dist from the built project to package the app for your os. Packages are created in the dist directory.

Once packages are built you can use the following commands:

  • $ npm run winsetup: create Windows installer.
  • $ npm run deb: create a Debian package.