Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
Signed-off-by: Konstantin Läufer <[email protected]>
  • Loading branch information
klaeufer committed Sep 6, 2024
1 parent 8afdd92 commit 38c344d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

Small project to get started with Scala and ScalaTest.


## Running the main program

```
$ sbt run
```


## Running the tests

```
Expand All @@ -22,6 +24,7 @@ $ sbt coverage test coverageReport

to see the code coverage percentages of your test suite.


## Running successive tasks with sbt

To speed up the edit-compile-test/run cycle, you can start sbt without arguments
Expand All @@ -45,3 +48,22 @@ To exit sbt, enter
```
sbt> exit
```


## Running outside of sbt

This lets you use your application on the command-line.

First, create the startup script:

```
sbt stage
```

Then run outside of sbt like this:

```
./target/universal/stage/bin/hello-scalatest-scala
```

On Windows, you might need backslashes. WSL (Windows Subsystem for Linux) recommended instead.
2 changes: 2 additions & 0 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ libraryDependencies ++= Seq(
"org.scalatest" %% "scalatest" % "3.2.19" % Test,
"org.scalacheck" %% "scalacheck" % "1.18.0" % Test
)

enablePlugins(JavaAppPackaging)

0 comments on commit 38c344d

Please sign in to comment.