Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PoslavskySV committed Apr 4, 2018
1 parent fe97345 commit 3eb63e9
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
[![image](https://readthedocs.org/projects/rings/badge/?version=latest)](https://rings.readthedocs.io)
[![image](http://www.javadoc.io/badge/cc.redberry/rings.svg)](http://www.javadoc.io/doc/cc.redberry/rings)
[![image](http://www.javadoc.io/badge/cc.redberry/rings.scaladsl_2.12.svg?label=scaladoc)](http://www.javadoc.io/doc/cc.redberry/rings.scaladsl_2.12)
[![image](https://img.shields.io/maven-central/v/cc.redberry/rings/2.svg?style=flat)](https://search.maven.org/#artifactdetails%7Ccc.redberry%7Crings%7C2.3%7Cjar)
[![image](https://img.shields.io/maven-central/v/cc.redberry/rings.scaladsl_2.12/2.svg?style=flat)](https://search.maven.org/#artifactdetails%7Ccc.redberry%7Crings.scaladsl_2.12%7C2.3%7Cjar)
[![image](https://img.shields.io/maven-central/v/cc.redberry/rings/2.svg?style=flat)](https://search.maven.org/#artifactdetails%7Ccc.redberry%7Crings%7C2.3.1%7Cjar)
[![image](https://img.shields.io/maven-central/v/cc.redberry/rings.scaladsl_2.12/2.svg?style=flat)](https://search.maven.org/#artifactdetails%7Ccc.redberry%7Crings.scaladsl_2.12%7C2.3.1%7Cjar)
[![image](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat)](https://opensource.org/licenses/Apache-2.0)

Rings: efficient Java/Scala library for polynomial rings
Expand All @@ -27,7 +27,7 @@ The full documentation is available at [<http://rings.readthedocs.io>](https://r
Set up
------

### Interactive Rings shell
### Interactive Rings shell and Rings scripts

To taste what Rings can do, one can try interactive session with [Ammonite REPL](http://ammonite.io). You can install Rings<i>.repl</i> with Homebrew:

Expand All @@ -47,7 +47,7 @@ Now run Rings<i>.repl</i>:
``` scala
$ rings.repl
Loading...
Rings 2.3: efficient Java/Scala library for polynomial rings
Rings 2.3.1: efficient Java/Scala library for polynomial rings

@ implicit val ring = MultivariateRing(Z, Array("x", "y", "z"))
ring: MultivariateRing[IntZ] = MultivariateRing(Z, Array("x", "y", "z"), LEX)
Expand All @@ -65,12 +65,18 @@ res13: FactorDecomposition[MultivariatePolynomial[IntZ]] =
*(z^2-2*y*z+y^2+x^2)
```

Additionally, Rings<i>.repl</i> can be used to run scripts with Rings code:

```
$ rings.repl myRingsScript.sc
```

### Java/Scala library

Rings is currently available for Java and Scala. To get started with Scala SBT, simply add the following dependence to your `build.sbt` file:

``` scala
libraryDependencies += "cc.redberry" %% "rings.scaladsl" % "2.3"
libraryDependencies += "cc.redberry" %% "rings.scaladsl" % "2.3.1"
```

For using Rings solely in Java there is Maven artifact:
Expand All @@ -79,7 +85,7 @@ For using Rings solely in Java there is Maven artifact:
<dependency>
<groupId>cc.redberry</groupId>
<artifactId>rings</artifactId>
<version>2.3</version>
<version>2.3.1</version>
</dependency>
```

Expand Down

0 comments on commit 3eb63e9

Please sign in to comment.