git-hulk commented on code in PR #4349:
URL: https://github.com/apache/carbondata/pull/4349#discussion_r1534943721
##########
build/README.md:
##########
@@ -15,31 +15,37 @@
limitations under the License.
-->
-# Building CarbonData
+# Build from source
## Prerequisites
+
* Unix-like environment (Linux, Mac OS X)
* Git
* [Apache Maven (Recommend version 3.3 or
later)](https://maven.apache.org/download.cgi)
* [Oracle Java
8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* [Apache Thrift 0.9.3](http://archive.apache.org/dist/thrift/0.9.3/)
-## Build command
Build with different supported versions of Spark, by default using Spark 2.4.5
-```
-mvn -DskipTests -Pspark-2.4 clean package
-```
-Note:
+To be noticed:
- If you are working in Windows environment, remember to add `-Pwindows`
while building the project.
- The mv feature is not compiled by default. If you want to use this feature,
remember to add `-Pmv` while building the project.
-## For contributors : To build the format code after any changes, please
follow the below command.
-Note:Need install Apache Thrift 0.9.3
-```
+## Development
+
+To build the format code after any changes, please follow the below command:
+
+```shell
mvn clean -DskipTests -Pbuild-with-format -Pspark-2.4 package
```
+And you can skip the `build-with-format` stage if you're building from the
release tarball
+or once the format codes are generated:
Review Comment:
```suggestion
And you can skip the build-with-format stage if you're building an assemble
jar:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscr...@carbondata.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
