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

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

Nigel Jones created ATLAS-197:
---------------------------------

             Summary: 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)