HowToCreateYourProject

From user's Wiki!
Jump to: navigation, search

Create your project

In order to generate the folder structure and the basic files needed for your new project, run the StartNewModule tool from the installation path (or from the src path in Linux).

  1. Specify the name of the new project in the Name field (e.g. idiabps)
  2. Specify the path where the new project will be created in the Root path field (e.g. C:\Code\src\)
  3. Select Project in the Type combo box
StartNewModule fields for new Project

The tool will create a new folder ’MyProject’. The content of this folder is shown here

MyProject Folders structure
Gimias Folders structure

This structure is quite similar to the one of Gimias. The two key files you should know in this structure are the csnMyProjectToolkit.py and the csnMyProject.py. In the first one you will add automatically the definition of every module you create with StartNewModule. Every time you want to use one of the modules (thirdParty, plugin or library) you created you will have to be sure that your csn file have the line from csnMyProjectToolkit import * . The second file is more about building a solution starting from Gimias and adding your plugin, every time you add a Plugin it will automatically be added to this file too. This is the file you have to choose in the CSnake instance if you want to build a solution that contains both Gimias (OS ) and your plugins.

csnMyProjectToolkit with definition of every module
Warning Warning: Folder structure

It's important to keep the source code of each project in a different folder and not to mix the source and the build folders.

We recommend to use this folder structure:

  • C:\Code\src\
    • GIMIAS_1_3\: For gimias source code
    • myProject\: For your project source code
  • C:\Code\bin\:
    • GIMIAS_1_3\: Binary folder of GIMIAS
    • myProject\: Binary folder of your project


Set up your environment

Now you can open the CSnake and add your source folders like in the following picture.

CSnake Configuration
Warning Warning: Folder structure

Take care of the folder configuration. Is very important not to mix folders of different projects.

  • Global Build folder will be the GIMIAS folder: C:\Code\build\GIMIAS_1_3\
  • Each third party source folder needs its own third party build folder:
    • C:\Code\build\GIMIAS_1_3\thirdParty
    • C:\Code\build\idibaps\thirdParty

Next Steps:

Go back to Developers