-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ReadMe updates for contributors (#34)
* Fix typo in private key generation * update development notes
- Loading branch information
1 parent
5a82101
commit 819b2c0
Showing
1 changed file
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,44 @@ | ||
# Morphir JVM binding | ||
|
||
This repo contains tools to work with the Morphir IR on the@ JVM. It will include data models for the IR, JSON serialization and developer tooling. | ||
This repo contains tools to work with the Morphir IR on the JVM. It will include data models for the IR, JSON serialization and developer tooling. | ||
|
||
## How to build and test | ||
|
||
Morphir-jvm use [mill]("http://www.lihaoyi.com/mill/) as its build tool. | ||
|
||
### IntelliJ Setup | ||
|
||
If you are using IntelliJ IDEA to edit morphir-jvm's Scala code, you can create the | ||
IntelliJ project files via: | ||
|
||
```bash | ||
./mill mill.scalalib.GenIdea/idea | ||
``` | ||
|
||
### BSP Setup | ||
|
||
If you are using Visual Studio Code, IntelliJ, or any of the Editors which support BSP you can also generate BSP config files via: | ||
|
||
```bash | ||
./mill mill.contrib.Bloop/install | ||
``` | ||
|
||
### Run Tests | ||
|
||
```bash | ||
./mill __.test | ||
``` | ||
|
||
or in watch mode: | ||
|
||
```bash | ||
./mill -w __.test | ||
``` | ||
|
||
### Formatting Code | ||
|
||
Code needs to be formatted according to `scalafmt` rules. To run `scalafmt` on all the source code using: | ||
|
||
```bash | ||
./mill mill.scalalib.scalafmt.ScalafmtModule/reformatAll __.sources | ||
``` |