Skip to content

Commit

Permalink
First cut at documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffwilde committed Feb 9, 2015
1 parent 381d841 commit 44040b3
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Fresh Simple Scala Template
A [giter8] template which builds a simple [sbt] skeleton project to get your Scala coding off to a fresh start.

The generated project is configured with [ScalaTest], stub project package, and aims to keep up with sbt best practices.

# Usage
First install g8 by following the [readme](http://github.com/n8han/giter8#readme).
Then simply run the following shell command:

g8 jeffwilde/fresh

There are some properties that need to be specified (most can be left default)

| property | what it does
|--- |---
| title | A title for the project's README
| description | A description for the project's README
| organization | Basis for the containing package name
| artifact | Project artifact and package name

After g8 has finished:

cd <name>
sbt test
sbt run

Now that you're off to a fresh start, warm up your magic coding fingers and make something great!

# Author
Jeff Wilde <[email protected]>

# Licence
Copyright 2015 Complicated Robot Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[giter8]: https://github.com/n8han/giter8
[sbt]: http://www.scala-sbt.org/
[scalatest]: http://www.scalatest.org/

0 comments on commit 44040b3

Please sign in to comment.