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

Jong Wook Kim commented on S2GRAPH-100:
---------------------------------------

Turns out that the build process is as simple as installing SBT and running 
{{sbt package}}, thanks to the recent changes. Should be better to just add a 
short paragraph like the following, rather than having a separate file:

{noformat}
## Building from the source

To build S2Graph from the source, install the JDK 8 and 
[SBT](http://www.scala-sbt.org/), 
and run the following command in the project root:

    sbt package

This will create a distribution of S2Graph that is ready to be deployed.
{noformat}

Besides, I suppose it's better to replace the {{Quick Start (with Vagrant)}} 
part in {{README.md}} with the simpler option of using 
{{bin/start-s2graph.sh}}. Is there anyone against this idea?

> Add BUILD.md to explain how to package from source, then add it into REAME.md
> -----------------------------------------------------------------------------
>
>                 Key: S2GRAPH-100
>                 URL: https://issues.apache.org/jira/browse/S2GRAPH-100
>             Project: S2Graph
>          Issue Type: Sub-task
>    Affects Versions: 0.1.0
>            Reporter: DOYUNG YOON
>            Assignee: DOYUNG YOON
>             Fix For: 0.1.0
>
>   Original Estimate: 48h
>  Remaining Estimate: 48h
>
> Current README.md file do not have information on how to build from source. I 
> think we should add BUILD.md and link it in REAME.md, so users who download 
> source release can build and run it.



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

Reply via email to