[jira] [Commented] (QUICKSTEP-82) Clean release compilation and trial guide

["Julian Hyde (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/QUICKSTEP-82?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15933524#comment-15933524 ] 

Julian Hyde commented on QUICKSTEP-82:
--------------------------------------

I think it's misleading to call it BUILDING_RELEASE - that sounds like instructions for a release manager.

In my opinion, building instructions (or a pointer to them) should be in README. Include instructions both for building from a release and building from a git clone.

As an example, here are the contents of Calcite's {{README}}:

{noformat}
Apache Calcite release 1.11.0

This is a source or binary distribution of Apache Calcite.

Changes since the previous release are described in the
site/_docs/history.md file.

The LICENSE and NOTICE files contain license information.

If this is a source distribution, you can find instructions how to
build the release in the "Building from a source distribution" section
in site/_docs/howto.md.

README.md contains examples of running Calcite.

Further information about Apache Calcite is available at its web site,
http://calcite.apache.org.{noformat}

> Clean release compilation and trial guide
> -----------------------------------------
>
>                 Key: QUICKSTEP-82
>                 URL: https://issues.apache.org/jira/browse/QUICKSTEP-82
>             Project: Apache Quickstep
>          Issue Type: Improvement
>            Reporter: Jignesh Patel
>            Priority: Minor
>   Original Estimate: 2h
>  Remaining Estimate: 2h
>
> As we start making releases, it would be nice if we had a file BUILDING_RELEASE.md in the root directory that contained a step-by-step instruction for anyone to download the release tar file and compile and test the code. The file should be self-contained (i.e. not point to instructions in other file and/or wiki pages), and be as simple as possible. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)