Difference between revisions of "User documentation"

From Code::Blocks
m
(→‎Application development: add automatic source paths)
 
(64 intermediate revisions by 22 users not shown)
Line 1: Line 1:
 
[[Category:Code::Blocks Documentation]]
 
[[Category:Code::Blocks Documentation]]
 
[[Category:User Documentation]]
 
[[Category:User Documentation]]
Articles for Code::Blocks users.
+
== Official user document ==
 +
The Official Code::Blocks user document can be found [https://www.codeblocks.org/user-manual here].
 +
* Contributed [http://www.bt4.pl/programy/dla-programistow/code-blocks/ Polish translation].
 +
 
 +
== Using Code::Blocks ==
  
 
'''[[Installing Code::Blocks]]'''
 
'''[[Installing Code::Blocks]]'''
 +
:How to install Code::Blocks (from binary or source).
  
:How to install Code::Blocks (from binary or source)
+
'''[[Creating a new project]]'''
 +
:How to get started with project setup and management.
  
 
'''[[Keyboard Shortcuts]]'''
 
'''[[Keyboard Shortcuts]]'''
 +
:List of keyboard shortcuts that can be used in Code::Blocks.
 +
 +
'''[[Basic Tutorial]]'''
 +
:Information useful to make sense of Code::Blocks' settings (for newer users).
 +
 +
'''[[Command line arguments]]'''
 +
:List of command-line arguments that can be used with Code::Blocks.
 +
 +
'''[[Tools+ reference|User-defined tools]]'''
 +
:Integrate external programs into Code::Blocks.
 +
 +
'''[[The build process of Code::Blocks]]'''
 +
:Information about how Code::Blocks actually builds your source code.
 +
 +
'''[[wxSmith tutorials]]'''
 +
:Information about how to use wxSmith RAD editor
  
:List of keyboard shortcuts that can be used in Code::Blocks
+
'''[[Building an Non-Unicode Win32 Code::Blocks]]'''
 +
:Information about how to modify the Code::Blocks project files for an Non-Unicode build of Code::Blocks.
 +
 
 +
'''[[Code::Blocks and Makefiles]]'''
 +
:Using makefiles with CB is not normally necessary (CB does this automatically) but if you have some compelling reason to use one - here's how.
 +
 
 +
'''[[Variable expansion]]'''
 +
:CB can use ''dynamic'' variables, that get replaced automatically, on various places, like in the build options or the post and pre build steps
 +
 
 +
'''[[Manipulating multiple projects at the same time]]'''
 +
:To manipulate options of multiple projects at the same time you can use a contributed plugin named ''Project options manipulator''
 +
 
 +
'''[[Miscellaneous]]'''
 +
:Miscellaneous things related to the user development experience.  This is a catch all place.
 +
 
 +
== Customizing Code::Blocks ==
 +
 
 +
'''[[Scripting Code::Blocks]]'''
 +
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].
 +
 
 +
'''[[Syntax highlighting custom colour themes]]'''
 +
:Change the color of the editor, code highlighting
 +
 
 +
'''[[Code::Blocks Plugins]]'''
 +
:List of plugins that come with Code::Blocks.
  
 
'''[[Personalities]]'''
 
'''[[Personalities]]'''
 
 
:Customize the Code::Blocks user interface for different workflows.
 
:Customize the Code::Blocks user interface for different workflows.
  
'''[[Running under colinux|Running Code::Blocks under colinux]]'''
+
== Application development ==
  
:Running Code::Blocks in Linux under Windows.
+
* [[Variable expansion|Builtin variables]]
 +
* [[Recommended global variables]]
 +
* [[Code::Blocks variable types synthesis]]
 +
* [[Debugging with Code::Blocks]]
 +
* [[UnitTesting|Unit testing with Code::Blocks]]
 +
* [[Adding support for non C/C++ files to the build system]]
 +
* [[Codeblocks with scons|Integrating the SCons build system]]
 +
* [[Automatic source paths]]
  
 
== Compilers ==
 
== Compilers ==
  
== Integration ==
+
* [[Global compiler variables]]
 +
* [[Precompiled headers]]
 +
* [[Installing a supported compiler]]
 +
* [[Installing Cygwin Compiler]]
 +
* [[Installing Fortran Compiler]]
 +
* [[Installing Objective-C Compiler]]
 +
* [[Installing Uniwin remote compiler]]
 +
* [[Using Xming for remote compilation]]
 +
* [[Using STLFilt with MinGW]]
 +
* [[Code::Blocks and Cross Compilers|Using cross compilers]]
 +
* [[Cross Compiling wxWidgets Applications on Linux]]
 +
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
 +
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]
 +
* [[Using the Code::Blocks IDE with SDCC on PIC MCUs]]
 +
* [[Using Code::Blocks with Open Watcom]]
 +
* [[Custom compiler|Creating a custom compiler]] (Unfinished page.)
 +
* [[64Bit Windows|Setting up for 64-bit windows development with Mirosoft compilers]]
 +
* [[Developing 32 bit apps under 64 bit Linux (Ubuntu)]]
 +
* [https://www.orbiterwiki.org/wiki/Free_Compiler_Setup_Under_Linux External: Cross compiler MSVS 2005 under Linux through Wine]
 +
 
 +
== User interface development ==
 +
 
 +
<!-- * [[WxSmith Tutorial & Pointers|Creating a dialog for wxWidgets with wxSmith]] outdated -->
 +
* [[wxSmith tutorials|Creating a dialog for wxWidgets with wxSmith]]
 +
 
 +
== Third-party libraries ==
 +
 
 +
* [[BoostWindowsQuickRef|Using Boost with Code::Blocks (Windows)]]
 +
* [[Using wxWidgets|Using wxWidgets with Code::Blocks]]
 +
* [[Using SDL with Code::Blocks]]
 +
* [[Using GLFW with Code::Blocks]]
 +
* [[Using Allegro with Code::Blocks]]
 +
* [[Using FreeGlut with Code::Blocks]]
 +
* [[Using OpenCV with Code::Blocks]]
  
== Third-party Libraries ==
+
== Third-party Applications ==
  
'''[[Using SDL with Code::Blocks]]'''
+
* [[KiCadBuildQuickRef|How-to build KiCad with Code::Blocks]]

Latest revision as of 20:31, 11 February 2023

Official user document

The Official Code::Blocks user document can be found here.

Using Code::Blocks

Installing Code::Blocks

How to install Code::Blocks (from binary or source).

Creating a new project

How to get started with project setup and management.

Keyboard Shortcuts

List of keyboard shortcuts that can be used in Code::Blocks.

Basic Tutorial

Information useful to make sense of Code::Blocks' settings (for newer users).

Command line arguments

List of command-line arguments that can be used with Code::Blocks.

User-defined tools

Integrate external programs into Code::Blocks.

The build process of Code::Blocks

Information about how Code::Blocks actually builds your source code.

wxSmith tutorials

Information about how to use wxSmith RAD editor

Building an Non-Unicode Win32 Code::Blocks

Information about how to modify the Code::Blocks project files for an Non-Unicode build of Code::Blocks.

Code::Blocks and Makefiles

Using makefiles with CB is not normally necessary (CB does this automatically) but if you have some compelling reason to use one - here's how.

Variable expansion

CB can use dynamic variables, that get replaced automatically, on various places, like in the build options or the post and pre build steps

Manipulating multiple projects at the same time

To manipulate options of multiple projects at the same time you can use a contributed plugin named Project options manipulator

Miscellaneous

Miscellaneous things related to the user development experience. This is a catch all place.

Customizing Code::Blocks

Scripting Code::Blocks

Information about scripting Code::Blocks with Squirrel.

Syntax highlighting custom colour themes

Change the color of the editor, code highlighting

Code::Blocks Plugins

List of plugins that come with Code::Blocks.

Personalities

Customize the Code::Blocks user interface for different workflows.

Application development

Compilers

User interface development

Third-party libraries

Third-party Applications