10.0.0.21 Git - steamworks/blob - README.IDE

   1 # IDE Settings #
   2
   3 This file describes which settings to use in a variety of IDEs
   4 for building and developing Steamworks. For generic build-from-
   5 source instructions, see README and the Makefile.
   6
   7 ## Source Code Settings ##
   8
   9 SteamWorks code is written in the following style, which is
  10 close to the KDE Frameworks coding style. The style applies to
  11 all C++ code from SteamWorks, so:
  12
  13  - src/3rdparty is excluded (these contain verbatime copies of
  14    third-party code which have other style-guides),
  15  - src/pulley/pulleyscript/ is excluded (this is largely a C
  16    library, using Rick's coding style).
  17
  18 Style is as follows:
  19  - tabs for indent, spaces for alignment
  20  - tabs at 8
  21  - lines suggested maximum length 78
  22  - declare type* var, not type *var
  23  - spaces around operators, after commas
  24  - { } on lines of their own except in one-line const getter-methods
  25
  26 For new code, the overriding guideline is "follow what's in the
  27 file(s) already and blend in."
  28
  29
  30
  31 ## KDevelop ##
  32
  33 To use KDevelop as IDE while working on Steamworks, do the following:
  34  1- Run make(1) once in the toplevel, to create a build/ directory
  35     and do initial configuration.
  36  2- Select Open/Import an existing project.
  37  3- Select the src/ subdirectory as project directory, import from
  38     CMakeLists.txt.
  39  4- As a build directory, select the build/ subdirectory one level
  40     higher. KDevelop will suggest src/build, but you've already
  41     created build/ in step 1.
  42