Skip to content

Commit 74e6e93

Browse files
authored
Minor refactor the build/README.md (#4349)
* Minor refactor the build docs * Fix review comments * Update build/README.md
1 parent c1b0e9c commit 74e6e93

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

Diff for: build/README.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,36 @@
1515
limitations under the License.
1616
-->
1717

18-
# Building CarbonData
18+
# Build from source
1919

2020
## Prerequisites
21+
2122
* Unix-like environment (Linux, Mac OS X)
2223
* Git
2324
* [Apache Maven (Recommend version 3.3 or later)](https://maven.apache.org/download.cgi)
2425
* [Oracle Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
2526
* [Apache Thrift 0.9.3](http://archive.apache.org/dist/thrift/0.9.3/)
2627

27-
## Build command
2828
Build with different supported versions of Spark, by default using Spark 2.4.5
29-
```
30-
mvn -DskipTests -Pspark-2.4 clean package
31-
```
3229

33-
Note:
30+
To be noticed:
3431
- If you are working in Windows environment, remember to add `-Pwindows` while building the project.
3532
- The mv feature is not compiled by default. If you want to use this feature, remember to add `-Pmv` while building the project.
3633

37-
## For contributors : To build the format code after any changes, please follow the below command.
38-
Note:Need install Apache Thrift 0.9.3
39-
```
34+
## Development
35+
36+
To build the format code after any changes, please follow the below command:
37+
38+
```shell
4039
mvn clean -DskipTests -Pbuild-with-format -Pspark-2.4 package
4140
```
4241

42+
And you can skip the build-with-format stage if you're building an assemble jar:
43+
44+
```shell
45+
mvn -DskipTests -Pspark-2.4 clean package
46+
```
47+
4348
# Building CarbonData notebook images
4449
[How to build carbondata notebook docker image by dockerfile](#How-to-build-carbondata-notebook-docker-image-by-dockerfile.md)
4550
[How to build carbondata notebook docker image by manual](#How-to-build-carbondata-notebook-docker-image-by-manual.md)

0 commit comments

Comments
 (0)