docs: add clearer description of language versions (#827)

Add clearer description of required programming languages and their versions. Solves #818
apitable · May 17, 2023 · 401275f · 401275f
1 parent 73aee6a
commit 401275f
Showing 1 changed file with 16 additions and 3 deletions.
diff --git a/docs/contribute/developer-guide.md b/docs/contribute/developer-guide.md
@@ -4,13 +4,25 @@ This guide helps you get started developing APITable.
 
 ## Dependencies
 
-Make sure you have the following dependencies and programming languages installed before setting up your developer environment:
+Before you start contributing to APITable, make sure you have the following tools and programming languages installed.
+
+Required tools:
 
 - `git`
 - [docker](https://docs.docker.com/engine/install/)
 - [docker-compose v2](https://docs.docker.com/engine/install/)
 - `make`
 
+Required programming languages:
+
+- Nodejs 16.15
+- Java 8
+- Rust (nightly)
+- Python 3.7 or above
+- A proper C/C++ compiler toolchain, e.g. GCC 4.8 or above, Clang 3.5 or above.
+
+The following subsections show the recommended way to install these dependencies. Note that on MacOS some libraries are also required, see the MacOS subsection for more information.
+
 ### Programming Languages
 
 If you are using MacOS or Linux.
@@ -29,7 +41,7 @@ sdk env install
 curl -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly --profile minimal -y && source "$HOME/.cargo/env"
 ```
 
-Also, Python 3.7 or above, and a proper C/C++ compiler toolchain (e.g. GCC) is required. On MacOS and Linux, Python is usually pre-installed, but its version may not meet the requirement. You can run `python --version` to check out the version of the built-in Python, if it is below 3.7, see below for the commands to install the required Python version on various systems.
+On MacOS and Linux, Python is usually pre-installed, but its version may not meet the requirement. You can run `python --version` to check out the version of the built-in Python, if it is below 3.7, see below for the commands to install the required Python version on various systems.
 
 ### MacOS
 
@@ -40,7 +52,8 @@ We recommend using [Homebrew](https://brew.sh/) for installing any missing depen
 brew install git
 brew install --cask docker
 brew install make
-brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman gcc
+brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman
+brew install gcc
 brew install python3
 ```