typetools / typetools/checker-framework
Make the tutorial more user-friendly by adding `build.gradle` files
Open
@smillst is already working on this.
Since Oct 21, 2020.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 440
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 134
Description
The Checker Framework manual says that no installation is necessary because you will probably use the Checker Framework with a build system such as Maven or Gradle. Then, the tutorial immediately asks users to download and install the Checker Framework.
(Parts of the tutorial use Ant. This still requires the Checker Framework to be downloaded.)
We should change the tutorial:
- create
build.gradlebuild files, one per example in the tutorial - change the tutorial instructions so the command to run is
./gradlew, notjavacorant - remove the instructions to install the Checker Framework
- remove uses of "from the command line" throughout, because it is no longer necessary to make a distinction with the Eclipse version. The instructions can say that a user may run the tutorial in an IDE.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.