Skip to content

Commit

Permalink
updates for the 0.4 release
Browse files Browse the repository at this point in the history
  • Loading branch information
darrenjw committed Dec 22, 2020
1 parent c19dba4 commit 83b3497
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 14 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

## Installation/Getting started

This library is simplest to use with [SBT](http://www.scala-sbt.org/). You should install SBT before attempting to use this library.
This library is simplest to use with [`sbt`](http://www.scala-sbt.org/). You should install `sbt` before attempting to use this library.

To use the pre-built binary, add the following lines to your `build.sbt`:
```scala
libraryDependencies += "com.github.darrenjw" %% "scala-glm" % "0.3"
libraryDependencies += "com.github.darrenjw" %% "scala-glm" % "0.4"
```
The current [stable release](ReleaseNotes.md) is "0.3". Releases are cross-built for both Scala 2.11 and 2.12 and published to the [central repository](http://central.sonatype.org/).
The current [stable release](ReleaseNotes.md) is "0.4". It is cross-built for both Scala 2.12 and 2.13 and published to the [central repository](http://central.sonatype.org/). Version 0.3 was the final release for Scala 2.11.

There is a [giter8](http://www.foundweekends.org/giter8/) template for `scala-glm`, so using recent versions of SBT you can create a minimal `scala-glm` project template with:
```bash
Expand All @@ -20,8 +20,8 @@ sbt new darrenjw/scala-glm.g8
If you just want to try out the library without setting up any kind of project, you can do so with a session like:
```
$ sbt
> set scalaVersion := "2.12.1"
> set libraryDependencies += "com.github.darrenjw" %% "scala-glm" % "0.3"
> set scalaVersion := "2.13.4"
> set libraryDependencies += "com.github.darrenjw" %% "scala-glm" % "0.4"
> console
scala> import scalaglm._
```
Expand All @@ -34,7 +34,7 @@ This library has a dependence on [Breeze](https://github.com/scalanlp/breeze), s
If you want to use the latest snapshot, add the following to your `build.sbt`:

```scala
libraryDependencies += "com.github.darrenjw" %% "scala-glm" % "0.4-SNAPSHOT"
libraryDependencies += "com.github.darrenjw" %% "scala-glm" % "0.5-SNAPSHOT"
resolvers += "Sonatype Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots/"
```

Expand All @@ -52,6 +52,6 @@ If building from source, running `sbt console` from this directory should give a

## Author

This library is Copyright (C) 2017 [Darren J Wilkinson](https://github.com/darrenjw), but released as open source software under an Apache 2.0 license.
This library is Copyright (C) 2017-2020 [Darren J Wilkinson](https://github.com/darrenjw), but released as open source software under an Apache 2.0 license.


18 changes: 14 additions & 4 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# scala-glm

## Release notes
### Release notes

### 0.4


## 0.4

* Updated library dependencies and cross-built for Scala 2.12 and 2.13
*
* First version supporting Scala 2.13
* Dropped Scala 2.11 from cross-build. Version 0.3 is final Scala 2.11 release

### 0.3
## 0.3

* First official sonatype release, cross-built for Scala 2.11 and 2.12
* PCA, including human-readable summaries and diagnostic plots
Expand All @@ -19,4 +22,11 @@
* Example code
* Tutorial documentation

## 0.2

* Early test release

## 0.1

* Initial test release

2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

name := "scala-glm"
organization := "com.github.darrenjw"
version := "0.4-SNAPSHOT"
version := "0.4"

scalacOptions ++= Seq(
"-unchecked", "-deprecation", "-feature"
Expand Down
2 changes: 1 addition & 1 deletion example-scripts/build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ scalacOptions ++= Seq(

libraryDependencies ++= Seq(
"org.scalatest" %% "scalatest" % "3.2.2" % "test",
"com.github.darrenjw" %% "scala-glm" % "0.4-SNAPSHOT",
"com.github.darrenjw" %% "scala-glm" % "0.4",
"org.ddahl" %% "rscala" % "3.2.19"
)

Expand Down
2 changes: 1 addition & 1 deletion examples/build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ scalacOptions ++= Seq(

libraryDependencies ++= Seq(
"org.scalatest" %% "scalatest" % "3.2.2" % "test",
"com.github.darrenjw" %% "scala-glm" % "0.4-SNAPSHOT",
"com.github.darrenjw" %% "scala-glm" % "0.4",
"org.ddahl" %% "rscala" % "3.2.19"
)

Expand Down

0 comments on commit 83b3497

Please sign in to comment.