summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2021-12-21 12:37:37 +0000
committerJuan J. Martinez <jjm@usebox.net>2021-12-21 12:37:37 +0000
commitb5b419ad0a89b36e136f4509a59a145f991e833d (patch)
tree132816e3147b78effc7806a069ea906b25caf0a3 /README.md
parent91394146bbb39633916a8f3fdaa060665db1bc6f (diff)
downloadspacebeans-b5b419ad0a89b36e136f4509a59a145f991e833d.tar.gz
spacebeans-b5b419ad0a89b36e136f4509a59a145f991e833d.zip
Scalafmt mention
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index d7009e8..4b5abf8 100644
--- a/README.md
+++ b/README.md
@@ -145,6 +145,14 @@ Run the server with `./mill server.run` and the tests with `./mill server.test`.
To build the `jar` bundle, run `./mill server.assembly` and the result will be generated
in `out/server/assembly/dest/`.
+The sources must be formatted with `scalafmt`, either via your editor or running:
+
+```
+./mill mill.scalalib.scalafmt.ScalafmtModule/reformatAll __.sources
+```
+
+This will be enforced by CI.
+
## License
Copyright (C) 2021 Juan J. Martinez <jjm@usebox.net>