Skip to content

Commit

Permalink
added instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kaliumxyz committed May 7, 2017
1 parent 73ce74d commit ae8cc38
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# ASAP
### A Simple Aesthetic Particle engine.
# ASAP [![Build Status](https://travis-ci.org/kaliumxyz/ASAP.svg?branch=master)](https://travis-ci.org/kaliumxyz/ASAP)[![Dependency Status](https://dependencyci.com/github/kaliumxyz/ASAP/badge)](https://dependencyci.com/github/kaliumxyz/ASAP)
> A Simple Aesthetic Particle engine.
“Imagine a vast sheet of paper on which straight Lines, Triangles, Squares, Pentagons, Hexagons, and other figures, instead of remaining fixed in their places, move freely about, on or in the surface, but without the power of rising above or sinking below it, very much like shadows—only hard with luminous edges—and you will then have a pretty correct notion of my country and countrymen.” ― Edwin A. Abbott, Flatland: A Romance of Many Dimensions
*“Imagine a vast sheet of paper on which straight Lines, Triangles, Squares, Pentagons, Hexagons, and other figures, instead of remaining fixed in their places, move freely about, on or in the surface, but without the power of rising above or sinking below it, very much like shadows—only hard with luminous edges—and you will then have a pretty correct notion of my country and countrymen.” ― Edwin A. Abbott, Flatland: A Romance of Many Dimensions*


## install
Just clone the repo or download the files.
```
$ git clone https://github.com/kaliumxyz/asap
```
Then go to the dir and run nmp
```
$ cd asap
$ npm
```


## usage
Just run electron in the dir.
```
$ electron .
```

## license
MIT © [Kalium](kalium.xyz)

0 comments on commit ae8cc38

Please sign in to comment.