Skip to content

Commit 918b2cd

Browse files
authored
Merge pull request #6 from scala/SethTisue-patch-1
Dotty -> Scala 3
2 parents 5c49437 + d4d628e commit 918b2cd

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
1-
# Example mill project that compiles using Dotty
1+
# Example mill project that compiles using Scala 3
22

3-
**NOTE**: Dotty support in mill is experimental. For now, sbt remains the
4-
preferred option, see http://github.com/lampepfl/dotty-example-project for an
3+
**NOTE**: Scala 3 support in mill is experimental. For now, sbt remains the
4+
preferred option. See https://github.com/scala/scala3-example-project for an
55
example sbt project.
66

77
## Usage
88

9-
This is a normal mill project, you can compile code with `mill root.compile` and run it
10-
with `mill root.run`, `mill -i root.console` will start a Dotty REPL.
9+
This is a normal mill project. You can compile code with `mill root.compile` and run it
10+
with `mill root.run`, `mill -i root.console` will start a Scala 3 REPL.
1111

1212
### IDE support
1313

14-
Dotty comes built-in with IDE support, unfortunately this support is only
14+
Scala 3 comes built-in with IDE support, unfortunately this support is only
1515
available using sbt and not mill for now, see http://dotty.epfl.ch/docs/usage/ide-support.html
1616

17-
## Using Dotty in an existing project
17+
## Using Scala 3 in an existing project
1818

1919
### build.sc
20-
Any version number that starts with `0.` is automatically recognized as Dotty,
20+
Any version number that starts with `3.` is automatically recognized as Scala 3;
2121
you don't need to set up anything:
2222

2323
```scala
2424
def scalaVersion = "3.0.1"
2525
```
2626

2727
#### Nightly builds
28-
If the latest release of Dotty is missing a bugfix or feature you need, you may
29-
wish to use a nightly build. Look at the bottom of
30-
https://repo1.maven.org/maven2/ch/epfl/lamp/dotty_0.14/ to find the version
31-
number for the latest nightly build.
3228

33-
## Getting your project to compile with Dotty
29+
If the latest release of Scala 3 is missing a bugfix or feature you need, you may
30+
wish to use a nightly build. Look at the bottom of the list of
31+
[releases](https://repo1.maven.org/maven2/org/scala-lang/scala3-compiler_3/)
32+
to find the version number for the latest nightly build.
33+
34+
## Getting your project to compile with Scala 3
3435

3536
When porting an existing project, it's a good idea to start out with the Scala 2
3637
compatibility mode (note that this mode affects typechecking and thus may
37-
prevent some valid Dotty code from compiling) by adding to your `build.sc`:
38+
prevent some valid Scala 3 code from compiling) by adding to your `build.sc`:
3839

3940
```scala
4041
def scalacOptions = T {
@@ -46,13 +47,13 @@ def scalacOptions = T {
4647
```
4748

4849
Using the `Dep.isDotty` method ensures that this option will only be set when
49-
compiling with Dotty.
50+
compiling with Scala 3.
5051

51-
A tool to port code from Scala 2.x to Dotty is currently in development at
52-
https://github.com/scalacenter/scalafix
52+
A tool to port code from Scala 2.x to Scala 3 is available; see
53+
https://scalacenter.github.io/scala-3-migration-guide/docs/tooling/scala-3-migrate-plugin.html
5354

5455
If your build contains dependencies that have only been published for Scala 2.x,
55-
you may be able to get them to work on Dotty by replacing:
56+
you may be able to get them to work on Scala 3 by replacing:
5657

5758
```scala
5859
ivy"a::b:c"
@@ -63,8 +64,3 @@ by:
6364
```scala
6465
ivy"a::b:c".withDottyCompat(scalaVersion())
6566
```
66-
67-
## Discuss
68-
69-
Feel free to come chat with us on the
70-
[Dotty gitter](http://gitter.im/lampepfl/dotty)!

0 commit comments

Comments
 (0)