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

Make java and python build requirement more clear in README #486

Merged
merged 4 commits into from
Jan 31, 2024

Conversation

KevinGe00
Copy link
Contributor

What changes are proposed in this pull request, and why are they necessary?

Adding clarity to Java and python versioning requirements for build in README after user reported some confusion.

@KevinGe00 KevinGe00 changed the title make java and python build requirement more clear Make java and python build requirement more clear in README Jan 31, 2024
README.md Outdated
@@ -66,12 +66,13 @@ git clone https://github.com/linkedin/coral.git

Build:

**Important:**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can skip this line.

README.md Outdated
@@ -66,12 +66,13 @@ git clone https://github.com/linkedin/coral.git

Build:

**Important:**
Please note that this project requires Python 3 and Java 8 to run. Set `JAVA_HOME` to the home of an appropriate version and then use:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can make the first sentence bold.

@KevinGe00 KevinGe00 merged commit 1fa2a10 into linkedin:master Jan 31, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants