b834af66bd0650300740144b1dc277746c7ca6e0

Author
Marco Zühlke <mzuehlke@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

sbt: add README (#7294)

Diff

 1diff --git a/plugins/sbt/README.md b/plugins/sbt/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..f1a5753b91121201bebaa1b1deb5afa601a7c933
 4--- /dev/null
 5+++ b/plugins/sbt/README.md
 6@@ -0,0 +1,32 @@
 7+# sbt plugin
 8+
 9+This plugin adds completion for the [sbt, the interactive build tool](https://scala-sbt.org/),
10+as well as some aliases for common sbt commands.
11+
12+To use it, add `sbt` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... sbt)
16+```
17+
18+## Aliases
19+
20+| Alias | Command               | Description                                                  |
21+|-------|-----------------------|--------------------------------------------------------------|
22+| sbc   | `sbt compile`         | Compiles the main sources                                    |
23+| sbcln | `sbt clean`           | Deletes all generated files                                  |
24+| sbcc  | `sbt clean compile`   | Deletes generated files, compiles the main sources           |
25+| sbco  | `sbt console`         | Starts Scala with the compiled sources and all dependencies  |
26+| sbcq  | `sbt console-quick`   | Starts Scala with all dependencies                           |
27+| sbcp  | `sbt console-project` | Starts Scala with sbt and the build definitions              |
28+| sbd   | `sbt doc`             | Generates API documentation for Scala source files           |
29+| sbdc  | `sbt dist:clean`      | Deletes the distribution packages                            |
30+| sbdi  | `sbt dist`            | Creates the distribution packages                            |
31+| sbgi  | `sbt gen-idea`        | Create Idea project files                                    |
32+| sbp   | `sbt publish`         | Publishes artifacts to the repository                        |
33+| sbpl  | `sbt publish-local`   | Publishes artifacts to the local Ivy repository              |
34+| sbr   | `sbt run`             | Runs the main class for the project                          |
35+| sbrm  | `sbt run-main`        | Runs the specified main class for the project                |
36+| sbu   | `sbt update`          | Resolves and retrieves external dependencies                 |
37+| sbx   | `sbt test`            | Compiles and runs all tests                                  |
38+| sba   | `sbt assembly`        | Create a fat JAR with all dependencies                       |