Statistics
| Branch: | Tag: | Revision:

amiro-os / tools / ide / QtCreator / README.txt @ 1678f270

History | View | Annotate | Download (4.51 KB)

1
AMiRo-OS support the QtCreator IDE and provides tools and manuals to setup the
2
according project files.
3

    
4
Copyright (C) 2016..2019  Thomas Schöpping
5

    
6
This program is free software: you can redistribute it and/or modify
7
it under the terms of the GNU General Public License as published by
8
the Free Software Foundation, either version 3 of the License, or (at
9
your option) any later version.
10

    
11
This program is distributed in the hope that it will be useful, but
12
WITHOUT ANY WARRANTY; without even the implied warranty of
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
General Public License for more details.
15

    
16
You should have received a copy of the GNU General Public License
17
along with this program.  If not, see <http://www.gnu.org/licenses/>.
18

    
19
This research/work was supported by the Cluster of Excellence
20
Cognitive Interaction Technology 'CITEC' (EXC 277) at Bielefeld
21
University, which is funded by the German Research Foundation (DFG).
22

    
23

    
24

    
25
################################################################################
26
#                                                                              #
27
#        RRRRRRRR   EEEEEEEE     AAA     DDDDDDDD   MM     MM  EEEEEEEE        #
28
#        RR     RR  EE          AA AA    DD     DD  MMM   MMM  EE              #
29
#        RR     RR  EE         AA   AA   DD     DD  MMMM MMMM  EE              #
30
#        RRRRRRRR   EEEEEE    AA     AA  DD     DD  MM MMM MM  EEEEEE          #
31
#        RR   RR    EE        AAAAAAAAA  DD     DD  MM     MM  EE              #
32
#        RR    RR   EE        AA     AA  DD     DD  MM     MM  EE              #
33
#        RR     RR  EEEEEEEE  AA     AA  DDDDDDDD   MM     MM  EEEEEEEE        #
34
#                                                                              #
35
################################################################################
36

    
37
This file will help you to setup QtCreator projects for the operating system of
38
the three basic AMiRo modules and more. It also provides instructions how to
39
integrate the GCC ARM embedded toolchain into the IDE.
40

    
41
================================================================================
42

    
43
CONTENTS:
44

    
45
  1  Setting up QtCreator Projects
46
  2  Integration of the Toolchain
47
    2.1  Toolkit Setup
48
    2.2  Project Integration
49

    
50
================================================================================
51

    
52

    
53

    
54
1 - SETTING UP QtCreator PROJECTS
55
---------------------------------
56

    
57
To automatically generate all required files for QtCreator, run the provided
58
./setup.sh script and follow the instruction. You then just have to open the
59
*.creator files with the IDE.
60

    
61

    
62

    
63
2 - INTEGRATION OF THE TOOLCHAIN
64
--------------------------------
65

    
66
In order to integrate the compiler and flashing tools into your IDE, some
67
further actions are required.
68

    
69

    
70
2.1 Toolkit Setup
71
-----------------
72

    
73
Start by launching the QtCreator application, open the Tools->Options settings
74
and select "Build & Run". Under the tab "Compilers" add the installed
75
arm-none-eabi-g++ compiler as another GCC. Under the tab "Debuggers" add the
76
according arm-none-eabi-gdb debugger. Under the tab "Kits" you need to manually
77
create a new kit with the following settings:
78

    
79
  Name: AMiRo
80
  Device type: Desktop
81
  Sysroot: <gcc-arm-none-eabi include path>
82
  Compiler: <the compiler added above>
83
  Debugger: <the debugger added above>
84
  QT version: none
85

    
86
Keep any other fields at their default values. If there is a warning sign shown
87
beside the new kit, check the settings for errors.
88

    
89

    
90
2.2 Project Integration
91
-----------------------
92

    
93
For convenience, the absolute path to your module (e.g.
94
/home/juser/amiro-os/os/modules/PowerManagement) will be referenced in the
95
following as "MOD_PATH".
96

    
97
After you have sucessfully created the project files (see section 1), open the
98
projects by selecting the *.creator files with QtCreator. Select the "Projects"
99
icon at the very left and switch to the "Build & Run" tab. Change the used kit
100
to "AMiRo" (right above the "Build" and "Run" buttons).
101

    
102
Next, add a new build configuration and call it "make":
103

    
104
  Build directory: MOD_PATH
105
  Build Steps: make --directory=MOD_PATH all
106
  Clean Steps: make --directory=MOD_PATH clean
107

    
108
Optionally, you can add "-j" to the build setp in order to parallelize the
109
compilation process. Add yet another build configuration by clonung the "make"
110
configuration and name it "make flash". For this copy, replace "all" at the end
111
of the build step with "flash". Finally remove the "Default" configuration and
112
repeat these steps for any further projects.
113

    
114
================================================================================
115