-
Notifications
You must be signed in to change notification settings - Fork 46
SysReq and minor updates to README added #741
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
fa0eacd
SysReq and minor updates to README added
olganaumenko edb20e9
Merge branch 'main' into olganaumenko/readme_minor_updates
olganaumenko 99307da
SysReq: for users and devs separately
olganaumenko 3db3be7
Merge branch 'main' into olganaumenko/readme_minor_updates
olganaumenko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,28 @@ | ||
# System requirements | ||
|
||
--- | ||
|
||
### To generate tests with UnitTestBot: | ||
|
||
you have to install IntelliJ IDEA (versions from 2022.1 to 2022.1.4 are supported). | ||
|
||
### To contribute to UnitTestBot: | ||
|
||
you have to install | ||
|
||
- IntelliJ IDEA (versions from 2022.1 to 2022.1.4 are supported); | ||
|
||
- JDK 11; | ||
|
||
- Kotlin 1.7.0 or later; | ||
|
||
you also have to check if | ||
|
||
- ```JAVA_HOME``` environment variable contains the path to JDK 11 installation directory; | ||
|
||
- ```PATH``` environment variable contains the path to the ```bin``` folder of JDK 11 installation directory; | ||
|
||
- ```KOTLIN_HOME``` environment variable contains the path to the ```kotlinc``` folder of Kotlin (1.7.0 or later) installation | ||
directory. | ||
|
||
Please note: if the environment variables lead to unsupported JDK or Kotlin versions, you won't be able to build the UnitTestBot project. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think, we should describe system requirements for developers and for contributors separately.
Requirements for developers should include supported Idea versions and a link to the IntelliJ page:
https://www.jetbrains.com/help/idea/supported-java-versions.html#2022
Additionally, we should describe how JAVA_HOME and KOTLIN_HOME may affect tests run.