Skip to content

Commit 664affc

Browse files
committed
add usage info to root doc page
1 parent ac93287 commit 664affc

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

src/rootdoc.txt

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,32 @@
1-
This is the documentation of the `introprog` Scala library with utilities used in beginner computer science teaching at Lund University.
1+
This is the documentation of the `introprog` Scala library with beginner-friendly utilities used in computer science teaching at Lund University. The code repository is hosted at [[https://github.com/lunduniversity/introprog-scalalib]].
22

33
== Package contents ==
44

5-
* [[introprog.PixelWindow `introprog.PixelWindow`]] for simple, pixel-based drawing.
5+
- [[introprog.PixelWindow `introprog.PixelWindow`]] for simple, pixel-based drawing.
66

7-
* [[introprog.PixelWindow.Event `introprog.PixelWindow.Event`]] for event management in a PixelWindow.
7+
- [[introprog.PixelWindow.Event `introprog.PixelWindow.Event`]] for event management in a PixelWindow.
8+
9+
- [[introprog.IO `introprog.IO`]] for file system interaction.
10+
11+
- [[introprog.Dialog `introprog.Dialog`]] for user interaction with standard GUI dialogs.
12+
13+
- [[introprog.examples `introprog.examples`]] with code examples demonstrating how to use this library.
14+
15+
== How to use this library with `sbt` ==
16+
17+
If you have [[https://www.scala-sbt.org/ `sbt`]] installed then you can put this text in a file called `build.sbt`
18+
19+
{{{
20+
scalaVersion := "2.12.6"
21+
libraryDependencies += "se.lth.cs" %% "introprog" % "1.0.0"
22+
}}}
23+
24+
When you run `sbt` in terminal the introprog lib is automatically downloaded and made available on your classpath.
25+
You can do things like:
26+
27+
{{{
28+
> sbt
29+
sbt> console
30+
scala> val w = new introprog.PixelWindow()
31+
scala> w.fill(100,100,100,100,java.awt.Color.red)
32+
}}}

0 commit comments

Comments
 (0)