Move IDE usage to IDE_USAGE.md
This commit is contained in:
Amine B. Hassouna
85
IDE_USAGE.md
Normal file
85
IDE_USAGE.md
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
# CMake sdl project - IDE usage
|
||||||
|
|
||||||
|
## Open the project with Qt Creator
|
||||||
|
|
||||||
|
[Qt Creator][] is a cross-platform C/C++ IDE, originally dedicated for the Qt framework.
|
||||||
|
It handle natively CMake projects and provide an efficient code completion.
|
||||||
|
|
||||||
|
*Install Qt creator:*
|
||||||
|
|
||||||
|
Install from Debian/Ubuntu repo:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo apt install qtcreator
|
||||||
|
```
|
||||||
|
|
||||||
|
Online installer: https://www.qt.io/download-thank-you?hsLang=en<br>
|
||||||
|
Offline installer: https://www.qt.io/offline-installers
|
||||||
|
|
||||||
|
*Open the project:*<br>
|
||||||
|
Run Qt Creator, use `Open Files or Project ...` and select the `CMakeLists.txt`
|
||||||
|
file of the cloned project.<br>
|
||||||
|
Finally, build and run the project.
|
||||||
|
|
||||||
|
|
||||||
|
## Open the project with Code::blocks
|
||||||
|
|
||||||
|
[Code::Blocks][] is a well-known cross-platform C/C++ and Fortran IDE.
|
||||||
|
It handle CMake projects by wrapping them into native Code::Blocks projects.
|
||||||
|
|
||||||
|
*Install Code::Blocks*
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo apt install codeblocks
|
||||||
|
```
|
||||||
|
|
||||||
|
*Prepare the Code::Blocks project:*
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Create a folder for the Code::Blocks project
|
||||||
|
cd basic-c-sdl-project
|
||||||
|
mkdir -p build/codeblocks
|
||||||
|
cd build/codeblocks
|
||||||
|
|
||||||
|
# Generate a Code::Blocks project
|
||||||
|
cmake ../.. -G "CodeBlocks - Unix Makefiles"
|
||||||
|
```
|
||||||
|
|
||||||
|
*Open the project:*<br>
|
||||||
|
Run Code::Blocks, and open the project in `basic-c-sdl-project/build/codeblocks`.<br>
|
||||||
|
Finally, build and run the project.
|
||||||
|
|
||||||
|
|
||||||
|
## Open the project with Eclipse C/C++
|
||||||
|
|
||||||
|
[Eclipse][] is a well-known IDE, widely used in Java projects development, but
|
||||||
|
it also supports other programming languages, like in this case C/C++.
|
||||||
|
It handle CMake projects by wrapping them into native Eclipse projects.
|
||||||
|
|
||||||
|
*Download Eclipse C/C++:*
|
||||||
|
|
||||||
|
Online installer: https://www.eclipse.org/downloads<br>
|
||||||
|
Offline package: https://www.eclipse.org/downloads/packages
|
||||||
|
|
||||||
|
*Prepare the Eclipse project:*
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Create a folder for the Eclipse project outside this project
|
||||||
|
cd basic-c-sdl-project
|
||||||
|
mkdir ../eclipse-basic-c-sdl-project
|
||||||
|
cd ../eclipse-basic-c-sdl-project
|
||||||
|
|
||||||
|
# Generate an Eclipse project
|
||||||
|
cmake ../basic-c-sdl-project -G "Eclipse CDT4 - Unix Makefiles"
|
||||||
|
```
|
||||||
|
*Open the project:*<br>
|
||||||
|
Run Eclipse, and open the project in `eclipse-basic-c-sdl-project`.<br>
|
||||||
|
Create a new run configuration: Go to `Run` > `Run configurations` >
|
||||||
|
`C\C++ Application` and specify the C/C++ Application using `Search Project...`<br>
|
||||||
|
Finally, build and run the project.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[Qt Creator]: https://doc.qt.io/qtcreator
|
||||||
|
[Code::Blocks]: http://www.codeblocks.org
|
||||||
|
[Eclipse]: https://www.eclipse.org
|
||||||
82
README.md
82
README.md
@@ -49,84 +49,7 @@ some instructions in the CMakeLists.txt file and re-execute `cmake ..` and `make
|
|||||||
|
|
||||||
### Open the project with an IDE under Linux
|
### Open the project with an IDE under Linux
|
||||||
|
|
||||||
#### Open with Qt Creator
|
See [IDE_USAGE.md](IDE_USAGE.md) for details.
|
||||||
|
|
||||||
[Qt Creator][] is a cross-platform C/C++ IDE, originally dedicated for the Qt framework.
|
|
||||||
It handle natively CMake projects and provide an efficient code completion.
|
|
||||||
|
|
||||||
*Install Qt creator:*
|
|
||||||
|
|
||||||
Install from Debian/Ubuntu repo:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo apt install qtcreator
|
|
||||||
```
|
|
||||||
|
|
||||||
Online installer: https://www.qt.io/download-thank-you?hsLang=en<br>
|
|
||||||
Offline installer: https://www.qt.io/offline-installers
|
|
||||||
|
|
||||||
*Open the project:*<br>
|
|
||||||
Run Qt Creator, use `Open Files or Project ...` and select the `CMakeLists.txt`
|
|
||||||
file of the cloned project.<br>
|
|
||||||
Finally, build and run the project.
|
|
||||||
|
|
||||||
|
|
||||||
#### Open with Code::blocks
|
|
||||||
|
|
||||||
[Code::Blocks][] is a well-known cross-platform C/C++ and Fortran IDE.
|
|
||||||
It handle CMake projects by wrapping them into native Code::Blocks projects.
|
|
||||||
|
|
||||||
*Install Code::Blocks*
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo apt install codeblocks
|
|
||||||
```
|
|
||||||
|
|
||||||
*Prepare the Code::Blocks project:*
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# Create a folder for the Code::Blocks project
|
|
||||||
cd basic-c-sdl-project
|
|
||||||
mkdir -p build/codeblocks
|
|
||||||
cd build/codeblocks
|
|
||||||
|
|
||||||
# Generate a Code::Blocks project
|
|
||||||
cmake ../.. -G "CodeBlocks - Unix Makefiles"
|
|
||||||
```
|
|
||||||
|
|
||||||
*Open the project:*<br>
|
|
||||||
Run Code::Blocks, and open the project in `basic-c-sdl-project/build/codeblocks`.<br>
|
|
||||||
Finally, build and run the project.
|
|
||||||
|
|
||||||
|
|
||||||
#### Open with Eclipse C/C++
|
|
||||||
|
|
||||||
[Eclipse][] is a well-known IDE, widely used in Java projects development, but
|
|
||||||
it also supports other programming languages, like in this case C/C++.
|
|
||||||
It handle CMake projects by wrapping them into native Eclipse projects.
|
|
||||||
|
|
||||||
*Download Eclipse C/C++:*
|
|
||||||
|
|
||||||
Online installer: https://www.eclipse.org/downloads<br>
|
|
||||||
Offline package: https://www.eclipse.org/downloads/packages
|
|
||||||
|
|
||||||
*Prepare the Eclipse project:*
|
|
||||||
|
|
||||||
```sh
|
|
||||||
# Create a folder for the Eclipse project outside this project
|
|
||||||
cd basic-c-sdl-project
|
|
||||||
mkdir ../eclipse-basic-c-sdl-project
|
|
||||||
cd ../eclipse-basic-c-sdl-project
|
|
||||||
|
|
||||||
# Generate an Eclipse project
|
|
||||||
cmake ../basic-c-sdl-project -G "Eclipse CDT4 - Unix Makefiles"
|
|
||||||
```
|
|
||||||
*Open the project:*<br>
|
|
||||||
Run Eclipse, and open the project in `eclipse-basic-c-sdl-project`.<br>
|
|
||||||
Create a new run configuration: Go to `Run` > `Run configurations` >
|
|
||||||
`C\C++ Application` and specify the C/C++ Application using `Search Project...`<br>
|
|
||||||
Finally, build and run the project.
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
@@ -143,6 +66,3 @@ This project is distributed under the terms of the MIT license
|
|||||||
[SDL2_image]: https://www.libsdl.org/projects/SDL_image
|
[SDL2_image]: https://www.libsdl.org/projects/SDL_image
|
||||||
[SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf
|
[SDL2_ttf]: https://www.libsdl.org/projects/SDL_ttf
|
||||||
[SDL2_gfx]: http://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx
|
[SDL2_gfx]: http://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx
|
||||||
[Qt Creator]: https://doc.qt.io/qtcreator
|
|
||||||
[Code::Blocks]: http://www.codeblocks.org
|
|
||||||
[Eclipse]: https://www.eclipse.org
|
|
||||||
|
|||||||
Reference in New Issue
Block a user