[
https://issues.apache.org/jira/browse/CALCITE-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17426246#comment-17426246
]
Jacques Nadeau commented on CALCITE-4840:
-----------------------------------------
I posted a patch of the changes I was thinking about. I'm not about boiling the
ocean either...
WRT to README vs README.md, I would think having only a README.md would be
sufficient but haven't read bylaws lately. Out of curiosity, I took a look at
the Spark 3.1.2 source distribution and it only has a README.md, not a README.
Anyway, not the most important thing, I was just trying to improve small things
along the way with fresh eyes where possible. If you're against any changes
with this ticket and my patch, I'm fine to abandon both.
> 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)