-
-
Notifications
You must be signed in to change notification settings - Fork 360
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More Documentation Review Updates (#3854)
* Broke out a new top-level section `The Mill CLI` for what was
previously `Installation & IDE Support`
* Broke out `Mill Command-Line Flags` and `Other installation methods`
into their own sections
* Moved documentation for `--interactive`/`--watch`/`--jobs` into `Mill
Command-Line Flags`
* Moved the `Realistic {language} Example Project` from `build-examples`
to `{language}lib/intro.adoc`
* This helps make a clearer separation between the "tutorial
read-from-top-to-bottom" `intro.adoc` and the rest of the stuff in each
language-specific section which is more "look up stuff as necessary"
* Deleted the `nested-modules` example. Probably not important enough to
deserve a full example/doc on its own
* `build-examples.adoc` now only contains `Example builds for real
projects` and `Real World Mill Builds`
* Add a reference to mill-mima under the Linting pages for Java and
Scala (not sure if it works well with Kotlin so left that out)
* Add the missing kotlin web examples to the kotlin doc pages- Loading branch information
Showing
80 changed files
with
453 additions
and
849 deletions.
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
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
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
120 changes: 120 additions & 0 deletions
120
docs/modules/ROOT/pages/cli/alternate-installation.adoc
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 |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| = Other installation methods | ||
|
|
||
| CAUTION: The installation methods listed below are maintained outside of Mill and may not have | ||
| the same features as the xref:cli/installation-ide.adoc#_bootstrap_scripts[bootstrap scripts]. You can try using them, | ||
| but the officially supported way to use Mill is via the bootstrap script above, so the Mill | ||
| maintainers may be unable to help you if you have issues with some alternate installation method. | ||
|
|
||
| CAUTION: Some of the installations via package managers install a fixed version of Mill and | ||
| do not support project-specific selection of the preferred Mill version. If you want to use | ||
| the `MILL_VERSION` environment variable or need support for `.mill-version` or | ||
| `.config/mill-version` files to control the actual used Mill version, please use | ||
| a xref:cli/installation-ide.adoc#_bootstrap_scripts[bootstrap script] instead. | ||
|
|
||
| == OS X | ||
|
|
||
| Installation via https://github.com/Homebrew/homebrew-core/blob/master/Formula/m/mill.rb[homebrew]: | ||
|
|
||
| [source,sh] | ||
| ---- | ||
| brew install mill | ||
| ---- | ||
|
|
||
|
|
||
| == Arch Linux | ||
|
|
||
| Arch Linux has an https://archlinux.org/packages/extra/any/mill/[Extra package for mill]: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| pacman -S mill | ||
| ---- | ||
|
|
||
| == FreeBSD | ||
|
|
||
| Installation via http://man.freebsd.org/pkg/8[pkg(8)]: | ||
|
|
||
| [source,sh] | ||
| ---- | ||
| pkg install mill | ||
| ---- | ||
|
|
||
| == Gentoo Linux | ||
|
|
||
| [source,sh] | ||
| ---- | ||
| emerge dev-java/mill-bin | ||
| ---- | ||
|
|
||
| == Windows | ||
|
|
||
| To get started, download Mill from | ||
| {mill-github-url}/releases/download/{mill-last-tag}/{mill-last-tag}-assembly[Github releases], and save it as `mill.bat`. | ||
|
|
||
| If you're using https://scoop.sh[Scoop] you can install Mill via | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| scoop install mill | ||
| ---- | ||
|
|
||
| == WSL / MSYS2 / Cycgin / Git-Bash | ||
|
|
||
| Mill also works on "sh" environments on Windows (e.g., | ||
| https://www.msys2.org[MSYS2], | ||
| https://www.cygwin.com[Cygwin], | ||
| https://gitforwindows.org[Git-Bash], | ||
| https://docs.microsoft.com/en-us/windows/wsl[WSL]); to get started, follow the instructions in the <<_manual>> | ||
| section. Note that: | ||
|
|
||
| * In some environments (such as WSL), Mill might have to be run without a server (using `-i`, `--interactive`, or `--no-server`.) | ||
|
|
||
| * On Cygwin, run the following after downloading mill: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| sed -i '0,/-cp "\$0"/{s/-cp "\$0"/-cp `cygpath -w "\$0"`/}; 0,/-cp "\$0"/{s/-cp "\$0"/-cp `cygpath -w "\$0"`/}' /usr/local/bin/mill | ||
| ---- | ||
|
|
||
| == Docker | ||
|
|
||
| You can download and run | ||
| a https://hub.docker.com/r/nightscape/scala-mill/["Docker image containing OpenJDK, Scala and Mill"] using | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| docker pull nightscape/scala-mill | ||
| docker run -it nightscape/scala-mill | ||
| ---- | ||
|
|
||
| == Manual | ||
|
|
||
| To get started, download Mill and install it into your HOME ".local/bin" via the following | ||
| `curl`/`chmod` command: | ||
|
|
||
| [source,bash,subs="verbatim,attributes"] | ||
| ---- | ||
| sh -c "curl -L {mill-github-url}/releases/download/{mill-last-tag}/{mill-last-tag} > ~/.local/bin/mill && chmod +x ~/.local/bin/mill" | ||
| ---- | ||
|
|
||
| == Coursier (unsupported) | ||
|
|
||
| Installing mill via `coursier` or `cs` is currently not officially supported. | ||
| There are various issues, especially with interactive mode. | ||
|
|
||
| == Asdf (unsupported) | ||
|
|
||
| You can install and manage Mill via the Multiple Runtime Version Manager - https://asdf-vm.com/[`asdf`]. | ||
|
|
||
| Support by `asdf` is currently possible by using the https://github.com/asdf-community/asdf-mill[`asdf-mill` plugin]: | ||
|
|
||
| .Steps to install the `mill` plugin and Mill with `asdf` | ||
| [source,bash] | ||
| --- | ||
| asdf plugin add mill | ||
| asdf install mill latest | ||
| asdf global mill latest | ||
| --- |
Oops, something went wrong.