aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNoel Welsh <noel@untyped.com>2017-02-16 22:52:45 +0000
committerNoel Welsh <noel@untyped.com>2017-02-16 22:52:45 +0000
commit1b33d72cd839b5897545cd9d4f92696932192c91 (patch)
tree36cff40f4ec038ca503ffb3102e20799bcc18264
parent274ab85d635b98bce7b89bff330f3e8bd44678f5 (diff)
downloadcreative-scala-template-1b33d72cd839b5897545cd9d4f92696932192c91.tar.gz
creative-scala-template-1b33d72cd839b5897545cd9d4f92696932192c91.tar.bz2
creative-scala-template-1b33d72cd839b5897545cd9d4f92696932192c91.zip
Better (and corrected) README
.bat for Windows, .sh for everyone else
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1c25928..e9e5980 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,12 @@
This is a template project designed for people taking [Creative Scala][creative-scala].
-Fork or clone this template. Then run `sbt.bat` (OS X and Linux) or `sbt.sh` to get coding!
+Fork or clone this template. (What's the difference? If you fork this repository you get your own copy on Github. You can then clone that repository to get a copy on your computer and save work back to your fork on Github and share it with other programmers. If you clone this repository without forking you get a copy on your computer but no copy on Github that you can save work back to and share.)
+
+Then run `sbt.sh` (OS X and Linux) or `sbt.bat` (Windows) to start SBT.
+
+Finally type `console` in SBT and then type `Example.image.draw`. If you see a picture of three nested circles everything is working well.
+
+You can edit the file `Example.scala` to create your own code. See [Creative Scala][creative-scala] for more!
[creative-scala]: http://underscore.io/training/courses/creative-scala/