-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
10 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,18 @@ | ||
# \<ink-figure\> | ||
# Ink - Scientific web components | ||
|
||
Figure for blog | ||
Ink is a collection of web-components for scientific publishing - the standard equations, figures, and code. The idea of `ink` is to provide an easy to use article layout that lays a foundation for interactive documents. | ||
|
||
## Install the Polymer-CLI | ||
For example, the `ink-equation` class provides a `eqn.math` property that can easily be set when things change: | ||
|
||
First, make sure you have the [Polymer CLI](https://www.npmjs.com/package/polymer-cli) installed. Then run `polymer serve` to serve your element locally. | ||
 | ||
|
||
## Viewing Your Element | ||
## Installing from source | ||
|
||
``` | ||
$ polymer serve | ||
``` | ||
|
||
## Running Tests | ||
Ink uses [Polymer 2.0](https://www.polymer-project.org/) so if you are more familiar with the `polymer-cli` you can use that, if not, take a look at the `Makefile`. | ||
|
||
``` | ||
$ polymer test | ||
$ git clone [email protected]:rowanc1/ink.git | ||
$ cd ink | ||
$ make install | ||
$ make serve | ||
``` | ||
|
||
Your application is already set up to be tested via [web-component-tester](https://github.com/Polymer/web-component-tester). Run `polymer test` to run your application's test suite locally. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.