[ https://issues.apache.org/jira/browse/CALCITE-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17426005#comment-17426005 ]
Julian Hyde commented on CALCITE-4840: -------------------------------------- README.md is for GitHub. We don't remove README.md because, as a general principle, the source distro mirrors what is in GitHub. README is there because every source distro should have a README. I don't want to finish this process with two different sets of build instructions that will drift apart over time. (Already I am regretting putting "JDK 8 or higher" in howto.md and "this release is tested ... on Oracle JDK 8, ... 15" in history.md.) I also don't want to direct people to "build on JDK 8" because I don't want to be one of those projects that gets stuck on a particular JDK version forever. > Avatica readme for source release should have better build instructions > ----------------------------------------------------------------------- > > Key: CALCITE-4840 > URL: https://issues.apache.org/jira/browse/CALCITE-4840 > Project: Calcite > Issue Type: Improvement > Components: avatica > Reporter: Jacques Nadeau > Assignee: Jacques Nadeau > Priority: Major > Labels: newbie > > Right now, trying to figure out how you should build from the source release > is too difficult (unless I missed something). To find the rather meagre > instructions, you have to: > # Open the README and see it says use README.md > # Open README.md and follow the link to the avatica home > # Click develop > # Click avatica development guide link > # Find and click "build from a source distribution" > Good luck to someone to find that path :) > When you get there, it states java 8 or later but trying to build with Java > 17 fails. For reference, jvm I was using: > {{% java --version}} > {{openjdk 17 2021-09-14 LTS}} > {{OpenJDK Runtime Environment Corretto-17.0.0.35.2 (build 17+35-LTS)}} > {{OpenJDK 64-Bit Server VM Corretto-17.0.0.35.2 (build 17+35-LTS, mixed mode, > sharing)}} > > Ideally the readme (or an install.md or a single click) should include: > * Prerequisites to build (gradle 6.8.1 and Java 8?) > * How to check signature > * How to build & test > > -- This message was sent by Atlassian Jira (v8.3.4#803005)