[jira] [Commented] (ATLAS-197) Add build instructions in top level dir

["Nigel Jones (JIRA)" <ji...@apache.org>]

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

Nigel Jones commented on ATLAS-197:
-----------------------------------

Since I've built atlas a few times now I'd forgotten about this, but for new users I still think it is useful to have a pointer within a top level file to the build instructions

Personally I scan for a README, a file relating to install, built..

We could simply modify the README. This currently points to the atlas incubator page, but I think preferable would be to say

... you can go to the following page: 
http://atlas.incubator.apache.org/
or view the content here under docs/src/site/twiki

At least that gives the reader a local reference? - even though they are .twiki files

> Add build instructions in top level dir
> ---------------------------------------
>
>                 Key: ATLAS-197
>                 URL: https://issues.apache.org/jira/browse/ATLAS-197
>             Project: Atlas
>          Issue Type: Wish
>    Affects Versions: trunk
>            Reporter: Nigel Jones
>            Priority: Minor
>
> In early Atlas code we had a file (names something like Installation Steps) in the top level directory which directed the developer who'd downloaded the code from github as to how to build.
> However since the docs are now in twiki those build instructions are only found  several layers deep, and with twiki markup
> jonesn@jonesn-ThinkPad-W530:~/atlas/incubator-atlas$ find . -type f -print | xargs -n50 grep -y "mvn clean install"
> ./docs/src/site/twiki/InstallationSteps.twiki:export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean install
> A pointer to the user to read this file, or a quick summary should be added to the root



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)