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.

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

Improvements to the README #1

Closed
helenmasters opened this issue Apr 25, 2017 · 3 comments
Closed

Improvements to the README #1

helenmasters opened this issue Apr 25, 2017 · 3 comments
Assignees

Comments

@helenmasters
Copy link

As a user new to the Adopt OpenJDK area the README needs to have more information in it. It would benefit from a section along the lines of 'what is in this repository and why would I want to use it?'

In addition I've been trying to follow the steps outlined and there are some changes required there too. In the section below there isn't a test directory, the instruction cd /test/TestConfig doesn't work as TestConfig is at the top level. In addition it would be useful to put in an example for the format of the platform_on_which_to_test. Ideally there would be a list of all the available platforms which are valid for running tests on (this could be a link out to another github project containing the releases).

cd /test/TestConfig
  export JAVA_BIN=/location_of_JVM_under_test
  export SPEC=platform_on_which_to_test
  export JAVA_VERSION=[SE80|SE90] (SE90 default value)
  make -f run_configure.mk
@helenmasters
Copy link
Author

Please provide example settings for JAVA_BIN too, reference #5

@helenmasters
Copy link
Author

As Shelley mentioned here #7 the dependencies don't get pulled in by default so this instruction needs to be added to the README.

smlambert added a commit that referenced this issue May 5, 2017
Added a motivation section, added examples for JAVA_BIN and SPEC, and what command to run to get dependencies.
@smlambert
Copy link
Contributor

Closing this for now, as Helen's points have been addressed. We will need to do another pass of documentation improvements, but can create fresh issue listing those enhancements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants