Skip to content
This repository has been archived by the owner on Apr 22, 2020. It is now read-only.

Commit

Permalink
Adds basic docs to create a new project (#262)
Browse files Browse the repository at this point in the history
* Adds basic docs to create a new project
* Adds third step to create files
  • Loading branch information
juanpedromoreno authored Apr 27, 2017
1 parent 8c86f0b commit e0f837c
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,45 @@ addSbtPlugin("com.47deg" % "sbt-org-policies" % "0.4.18")

[comment]: # (End Replace)

## Creating New Org Project

1. Create a new project from our g8 template:

```scala
sbt new 47deg/org-template.g8
```

2. Fill the required information (you can see an example below):

```bash

...

name [Project Name]: Test
projectDescription [Project Description]:
project [project-name]: org-test
package [com.fortysevendeg]:
startYear [2017]:
organization_web [http://47deg.com]:
github_owner [47deg]:
github_repo [org-test]:
sbt_org_policies_version [0.4.18]:
Skipping existing file: ./test/.gitignore
Skipping existing file: ./test/build.sbt
Skipping existing file: ./test/project/build.properties
Skipping existing file: ./test/project/plugins.sbt

Template applied in ./test
```

The new project will be created in the `test` folder, with the basic structure and basic sbt configuration based on the sbt-org-policies plugin.

3. Create the organization files, to do so, from the project folder, you could just run:

```scala
sbt orgCreateFiles
```

[comment]: # (Start Copyright)
# Copyright

Expand Down

0 comments on commit e0f837c

Please sign in to comment.