[
https://issues.apache.org/jira/browse/CALCITE-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17426728#comment-17426728
]
Julian Hyde commented on CALCITE-4840:
--------------------------------------
[~zabetak], I believe that someone visiting
https://github.com/apache/calcite-avatica wants to see one thing in their
browser, and someone who has downloaded a source distribution wants to see
another thing. The README.md and README files are for those purposes,
respectively.
I think it would be difficult to serve both purposes with the same file. The
problem is to prevent people who have downloaded the source distribution from
opening the README.md file (as Jacques did).
According to
[GitHub|https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes]
the {{README.md}} file can be in other locations, such as the {{.github}} or
{{docs}} directory.
> 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)
