nancy.liao
2025-05-29 8d405b265285c368df2e9cf1c14acee7532e0ee7
doc/development/Development-Environment-Setup.md
@@ -2,11 +2,19 @@
This guide is just an help in case you haven't decided your development environment or your development environment match ours. 
We don't have any specific dependency on development tools, you can choose the one you prefer. Though if you want to contribute
you're required to  format the code using `clang-format` before you submit the pull request.
We use Eclipse CDT to develop the software under Linux (Ubuntu) and Visual Studio under windows.
We use Eclipse CDT to develop the software under Linux (Ubuntu) and Visual Studio under Windows.
First of all download the source code and compile it from command line as described in [build the library](build-the-library)
## Linux setup
## Eclipse
First of all download the source code and compile it from command line as described in [build the library](Build-the-library)
Download prerequisites:
```
sudo curl -L "https://github.com/google/styleguide/blob/gh-pages/cpplint/cpplint.py" -o /usr/bin/cpplint.py
sudo chmod a+x /usr/local/bin/cpplint.py
sudo apt-get install clang-format ninja-build
```
### Eclipse
Eclipse CDT has recently improved the support for Cmake projects, be sure to install the latest CDT version from the
marketplace, with cmake support. Remember to install `ninja` build system for integration with cmake.
@@ -18,19 +26,8 @@
It is also necessary to install clang-format and cpplint.py (from google). 
### Ubuntu setup
```
sudo curl -L "https://github.com/google/styleguide/blob/gh-pages/cpplint/cpplint.py" -o /usr/bin/cpplint.py
sudo chmod a+x /usr/local/bin/cpplint.py
sudo apt-get install clang-format ninja-build
```
Go to Window > Preferences > C++ > CppStyle and configure the path for `cpplint.py` you just downloaded.
Go to Project > Properties > C++ General > Formatter and select CppStyle as code formatter.
We also suggest to install a pre-commit hook that helps keeping the code well formatted.
```
./scripts/git-pre-commit-hook install
```
## Windows setup
(To be done ...)