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

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
brrd committed Oct 24, 2016
1 parent 9e71fe6 commit 23b8996
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions docs/installation-and-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,25 @@

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

## Installation from binaries
## Installation

The following installation method is recommended:
### Windows

1. Download prebuilt binaries for your os from the [Releases page](https://github.com/brrd/Abricotine/releases),
2. Extract the archive,
3. Run Abricotine.
Download the windows installer from the [Releases page](https://github.com/brrd/Abricotine/releases) and run it.

OSX users can also use Homebrew Cask: `$ brew cask install abricotine`.
### OSX

Windows installers and Linux packages are not released yet.
Download OSX prebuilt binaries from the [Releases page](https://github.com/brrd/Abricotine/releases), extract the archive (if necessary) and run Abricotine.

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

### Ubuntu, Debian and other Debian-based distributions

Download the provided .deb package from the [Releases page](https://github.com/brrd/Abricotine/releases) and install it.

### Other Linux distributions

Download linux prebuilt binaries from the [Releases page](https://github.com/brrd/Abricotine/releases), extract the archive and run Abricotine.

## Building and packaging

Expand All @@ -32,9 +40,10 @@ Windows installers and Linux packages are not released yet.

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

Run `$ npm run installer` to create installers from packages.
Once packages are built you can use the following commands:

Use `$ npm run dist` to run both commands sequentially.
* `$ npm run winsetup`: create Windows installer.
* `$ npm run deb`: create a Debian package.

#### Packaging for another os

Expand Down

0 comments on commit 23b8996

Please # to comment.