Difference between revisions of "User documentation"

From Code::Blocks
(fix some errors from last change)
(12 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
[[Category:User Documentation]]
 
[[Category:User Documentation]]
 
== Official user document ==
 
== Official user document ==
The Official Code::Blocks user document can be found [https://www.codeblocks.org/user-manual here]
+
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].
== Articles for Code::Blocks users ==
 
  
 +
== 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]]'''
 
'''[[Creating a new project]]'''
 
 
:How to get started with project setup and management.
 
:How to get started with project setup and management.
  
 
'''[[Keyboard Shortcuts]]'''
 
'''[[Keyboard Shortcuts]]'''
 +
:List of keyboard shortcuts that can be used in Code::Blocks.
  
: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]]'''
 
'''[[Command line arguments]]'''
 
 
:List of command-line arguments that can be used with Code::Blocks.
 
:List of command-line arguments that can be used with Code::Blocks.
 
'''[[Personalities]]'''
 
 
:Customize the Code::Blocks user interface for different workflows.
 
 
'''[[Code::Blocks Plugins]]'''
 
 
:List of plugins that come with Code::Blocks.
 
  
 
'''[[Tools+ reference|User-defined tools]]'''
 
'''[[Tools+ reference|User-defined tools]]'''
 
 
:Integrate external programs into Code::Blocks.
 
:Integrate external programs into Code::Blocks.
  
 
'''[[The build process of Code::Blocks]]'''
 
'''[[The build process of Code::Blocks]]'''
 
 
:Information about how Code::Blocks actually builds your source code.
 
:Information about how Code::Blocks actually builds your source code.
 
'''[[Scripting Code::Blocks]]'''
 
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].
 
  
 
'''[[wxSmith tutorials]]'''
 
'''[[wxSmith tutorials]]'''
Line 51: Line 37:
 
: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.
 
: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]]'''
 
:Miscellaneous things related to the user development experience.  This is a catch all place.
 
: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]]'''
 +
:Customize the Code::Blocks user interface for different workflows.
  
 
== Application development ==
 
== Application development ==
  
* [[Builtin variables]]
+
* [[Variable expansion|Builtin variables]]
 
* [[Recommended global variables]]
 
* [[Recommended global variables]]
 
* [[Code::Blocks variable types synthesis]]
 
* [[Code::Blocks variable types synthesis]]
 
* [[Debugging with Code::Blocks]]
 
* [[Debugging with Code::Blocks]]
 +
* [[UnitTesting|Unit testing with Code::Blocks]]
 
* [[Adding support for non C/C++ files to the build system]]
 
* [[Adding support for non C/C++ files to the build system]]
 +
* [[Codeblocks with scons|Integrating the SCons build system]]
  
 
== Compilers ==
 
== Compilers ==
  
 
* [[Global compiler variables]]
 
* [[Global compiler variables]]
** [[Per-project variables]]
 
 
* [[Precompiled headers]]
 
* [[Precompiled headers]]
 
* [[Installing a supported compiler]]
 
* [[Installing a supported compiler]]
Line 75: Line 80:
 
* [[Installing Uniwin remote compiler]]
 
* [[Installing Uniwin remote compiler]]
 
* [[Using Xming for remote compilation]]
 
* [[Using Xming for remote compilation]]
 +
* [[Using STLFilt with MinGW]]
 
* [[Code::Blocks and Cross Compilers|Using cross compilers]]
 
* [[Code::Blocks and Cross Compilers|Using cross compilers]]
* [[Cross Compiling wxWidgets Applications on Linux|Cross compiling wxWidgets applications on Linux]]
+
* [[Cross Compiling wxWidgets Applications on Linux]]
 
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
 
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
 
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]
 
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]
* [[64Bit Windows|Setting up for 64-bit windows development with Mirosoft compilers]]
 
 
* [[Using the Code::Blocks IDE with SDCC on PIC MCUs]]
 
* [[Using the Code::Blocks IDE with SDCC on PIC MCUs]]
 
* [[Using Code::Blocks with Open Watcom]]
 
* [[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)]]
 
* [[Developing 32 bit apps under 64 bit Linux (Ubuntu)]]
  
Line 92: Line 99:
  
 
* [[BoostWindowsQuickRef|Using Boost with Code::Blocks (Windows)]]
 
* [[BoostWindowsQuickRef|Using Boost with Code::Blocks (Windows)]]
* [[WxWindowsQuickRef|Using wxWidgets with Code::Blocks (Windows)]]
+
* [[Using wxWidgets|Using wxWidgets with Code::Blocks]]
 
* [[Using SDL with Code::Blocks]]
 
* [[Using SDL with Code::Blocks]]
 
* [[Using GLFW with Code::Blocks]]
 
* [[Using GLFW with Code::Blocks]]
 
* [[Using Allegro with Code::Blocks]]
 
* [[Using Allegro with Code::Blocks]]
 
* [[Using FreeGlut with Code::Blocks]]
 
* [[Using FreeGlut with Code::Blocks]]
* [http://opencv.willowgarage.com/wiki/CodeBlocks Using OpenCV with Code::Blocks]
+
* [[Using OpenCV with Code::Blocks]]
  
 
== Third-party Applications ==
 
== Third-party Applications ==
  
 
* [[KiCadBuildQuickRef|How-to build KiCad with Code::Blocks]]
 
* [[KiCadBuildQuickRef|How-to build KiCad with Code::Blocks]]

Revision as of 22:39, 28 September 2016

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