Skip to content

Commit

Permalink
Merge pull request #11 from aMarcireau/release
Browse files Browse the repository at this point in the history
Minor README edits
  • Loading branch information
Alexandre Marcireau authored Nov 27, 2017
2 parents 4a2eb3d + ca82139 commit 7b36475
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Origami is an open-source research tool focused on graphical representations of

## Download

Visit the [Releases](https://github.com/aMarcireau/origami/releases) page to download Origami for your platform. MacOS users should download *Origami-darwin-x64.zip*.
Visit the [Releases](https://github.com/aMarcireau/origami/releases) page to download Origami for your platform. MacOS users should download *Origami-darwin-x64.zip*.

## Themes

Expand All @@ -32,8 +32,10 @@ Follow these steps to download the source code, edit and build Origami:
For development, run from the *origami* folder the command `npm start`. It will trigger a development build whenever something from the *souce* directory changes.

In order to create a new release, run:
1. `npm run build` to generate production builds for each supported platform
2. `npm run release -- v<major>.<minor>.<patch> [--prerelease]` to create a new Github release (requires administration rights on this repository).
1. `npm run build` to generate production builds for each supported platform.
2. `npm run release` to create a new Github release (requires administration rights on this repository).

The code documentation is held in the [Wiki](https://github.com/aMarcireau/origami/wiki).

### Help out

Expand Down

0 comments on commit 7b36475

Please sign in to comment.