Skip to content

Commit a195f23

Browse files
authored
Merge pull request #13255 from SethTisue/cb-doc-tweaks
community build readme tweaks
2 parents 07c3b4d + 19ab68f commit a195f23

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

community-build/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
# Dotty Community Build
1+
# Scala 3 Community Build
22

3-
This project contains tests to build and test a corpus of open sources Scala projects against the latest version of Dotty.
3+
This project contains tests to build and test a corpus of open sources Scala projects against the latest version of Scala 3.
4+
5+
## Running it locally
46

57
To run the community build on a local machine, first fetch all the git submodules with `git submodule update --init` and run `sbt community-build/test` from the root of the dotty repo.
68

9+
To run a single project, you can use the usual syntax for running a single JUnit test, for example `community-build/testOnly -- *shapeless`
10+
711
## Adding your project
812

913
To add your project to the community build you can follow these steps:
1014

11-
1. Get your project to compile with Dotty. Instructions can be found on the [dotty-example-project](https://github.com/lampepfl/dotty-example-project).
12-
See the submodules in [community-projects](https://github.com/lampepfl/dotty/tree/master/community-build/community-projects/) for examples of projects that compile with Dotty.
15+
1. Get your project to compile with Scala 3. Instructions can be found on the [scala3-example-project](https://github.com/lampepfl/scala3-example-project).
16+
See the submodules in [community-projects](https://github.com/lampepfl/dotty/tree/master/community-build/community-projects/) for examples of projects that compile with Scala 3.
1317

1418
2. Open a PR against this repo that:
1519
- Adds your project as a new git submodule

0 commit comments

Comments
 (0)