Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme before preparation to merge into main repo #3

Merged
merged 2 commits into from
Feb 1, 2024
Merged

Updated readme before preparation to merge into main repo #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bcc9414
updated readme
kaiyaok2 Feb 1, 2024
70eca6b
fix readme
kaiyaok2 Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,41 @@
# Nondex-Gradle-Plugin
To use the plugin, add the following in your build.gradle:
To use the plugin, add the following in your build.gradle(.kts):
## Groovy
```
plugins {
id 'edu.illinois.nondexGradle' version '2.1.1'
id 'edu.illinois.nondexGradle' version '2.1.7'
}
```
Apply it to subjects (if any, optional):
```
subprojects {
apply plugin: 'edu.illinois.nondex'
}
```
## Kotlin
```
plugins {
id("edu.illinois.nondexGradle") version "2.1.1"
id("edu.illinois.nondexGradle") version "2.1.7"
}
```
Apply it to subjects (if any, optional):
```
subprojects {
apply(plugin = "edu.illinois.nondex")
}
```

The NonDex tasks are based off of Gradle's test task. As such, it is recommended to use the same configurations as the default test task by modifying the build.gradle as follows:
## Before
```
test {
useJUnitPlatform()
...
}
```
## After
```
tasks.withType(Test) {
useJUnitPlatform()
...
}
```
If you do not want to configure all the tasks that extend the Gradle Test task or if you want to configure the NonDex in a different way, you can specify the configurations for each individual NonDex task as needed.
Expand All @@ -43,6 +55,6 @@ To get more information on the task options, run:
./gradlew help --task nondexTest
```

If you want to have NonDex for Maven project or learn more about NonDex, please visit the [NonDex repository](https://github.com/TestingResearchIllinois/NonDex).
If you want to run NonDex on Maven projects or learn more about NonDex, please visit the [NonDex repository](https://github.com/TestingResearchIllinois/NonDex).


Loading