[Doc] Refine building steps to be more clear in ReadMe

README.rst

@@ -136,8 +136,8 @@ Take the "person knows person" edges to illustrate. Suppose the vertex chunk siz
   :align: center
   :alt: edge logical table2
 
-Libraries
-----------
+Building Libraries
+------------------
 
 Libraries are provided for reading, writing and transforming files in GraphAr,
 now the C++ library and the Spark library are available. And we are going to

cpp/README.rst

@@ -46,8 +46,9 @@ repository and navigated to the ``cpp`` subdirectory:
 .. code-block::
 
     $ git clone https://github.com/alibaba/GraphAr.git
+    $ cd GraphAr
     $ git submodule update --init
-    $ cd GraphAr/cpp
+    $ cd cpp
 
 Release build:
 
@@ -68,7 +69,7 @@ setting :code:`NAMESPACE` option with cmake:
 
     $ mkdir build
     $ cd build
-    $ cmake .. -DNAMESPACE=MyNamespace
+    $ cmake -DNAMESPACE=MyNamespace ..
     $ make -j8       # if you have 8 CPU cores, otherwise adjust
 
 Debug build with unit tests:
@@ -91,6 +92,7 @@ Build with examples:
     $ cd build-examples
     $ cmake -DBUILD_EXAMPLES=ON ..
     $ make -j8       # if you have 8 CPU cores, otherwise adjust
+    $ ./bgl_example  # run the BGL example
 
 Install
 ^^^^^^^^^
@@ -108,8 +110,17 @@ Building the API document with Doxgen:
 
 .. code-block:: shell
 
+    $ cd GraphAr/cpp
     $ pushd apidoc
     $ doxgen
     $ popd
 
 The API document is generated in the directory ``cpp/apidoc/html``.
+
+
+How to use
+-----------
+
+Please refer to our `GraphAr C++ API Reference`_.
+
+.. _GraphAr C++ API Reference: https://alibaba.github.io/GraphAr/reference/api-reference-cpp.html

docs/user-guide/getting-started.rst

@@ -179,7 +179,7 @@ This program first reads in the graph information file to obtain the metadata; t
 
 Please refer to `more examples <../applications/out-of-core.html>`_ to learn about the other available case studies utilizing GraphAr.
 
-.. _Building Steps: https://github.com/alibaba/GraphAr/blob/main/README.rst
+.. _Building Steps: https://github.com/alibaba/GraphAr/blob/main/README.rst#building-libraries
 
 .. _person.vertex.yml: https://github.com/GraphScope/gar-test/blob/main/ldbc_sample/csv/person.vertex.yml
 

docs/user-guide/spark-lib.rst

@@ -32,15 +32,17 @@ Make the graphar-spark-library directory as the current working directory:
 
 .. code-block:: shell
 
-   cd spark/
+   cd GraphAr/spark/
 
 Compile package:
 
 .. code-block:: shell
 
-   mvn package
+   mvn clean package -DskipTests
 
-After compilation, a similar file *graphar-0.1.0-SNAPSHOT-shaded.jar* is generated in the directory *spark/target/*.
+After compilation, a similar file *graphar-x.x.x-SNAPSHOT-shaded.jar* is generated in the directory *spark/target/*.
+
+Please refer to the `building steps <https://github.com/alibaba/GraphAr/tree/main/spark>`_ for more details.
 
 
 How to Use

spark/README.rst

@@ -9,6 +9,8 @@ Building GraphAr Spark
 System setup
 ^^^^^^^^^^^^^
 
+First, install Spark as documented on `their website`_. Currently, the GraphAr Spark library supports Spark 3.2+ with Scala 2.12.
+
 GraphAr Spark uses maven as a package build system.
 
 Building requires:
@@ -25,8 +27,9 @@ repository and navigated to the ``spark`` subdirectory:
 .. code-block::
 
     $ git clone https://github.com/alibaba/GraphAr.git
+    $ cd GraphAr
     $ git submodule update --init
-    $ cd GraphAr/spark
+    $ cd spark
 
 Build the package:
 
@@ -74,3 +77,5 @@ How to use
 Please refer to our `GraphAr Spark Library Documentation`_.
 
 .. _GraphAr Spark Library Documentation: https://alibaba.github.io/GraphAr/user-guide/spark-lib.html
+
+.. _their website: https://spark.apache.org/downloads.html