Statistics
| Branch: | Tag: | Revision:

amiro-os / Makefile @ e545e620

History | View | Annotate | Download (4.27 KB)

1 e545e620 Thomas Schöpping
################################################################################
2
# AMiRo-OS is an operating system designed for the Autonomous Mini Robot       #
3
# (AMiRo) platform.                                                            #
4
# Copyright (C) 2016..2018  Thomas Schöpping et al.                            #
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            #
9
# (at your option) any later version.                                          #
10
#                                                                              #
11
# This program is distributed in the hope that it will be useful,              #
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of               #
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                #
14
# GNU 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 Cognitive      #
20
# Interaction Technology 'CITEC' (EXC 277) at Bielefeld University, which is   #
21
# funded by the German Research Foundation (DFG).                              #
22
################################################################################
23
24
25
26
define HELP_TEXT
27
################################################################################
28
#                                                                              #
29
# Copyright (c) 2016..2018  Thomas Schöpping                                   #
30
#                                                                              #
31
# This is free software; see the source for copying conditions. There is NO    #
32
# warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  #
33
# The development of this software was supported by the Excellence Cluster     #
34
# EXC 227 Cognitive Interaction Technology. The Excellence Cluster EXC 227 is  #
35
# a grant of the Deutsche Forschungsgemeinschaft (DFG) in the context of the   #
36
# German Excellence Initiative.                                                #
37
#                                                                              #
38
################################################################################
39
40
  AMiRo-OS Makefile help
41
  ======================
42
43
ARGUMENTS:
44
45
  help:
46
      Prints this text.
47
48
  all:
49
      Builds the binaries for all modules.
50
51
  flash:
52
      Flashes all binaries to the hardware.
53
      If the binaries do not exist, they are created beforehand.
54
55
  clean:
56
      Deletes all temporary and binary files of all modules.
57
58
  <module>:
59
      Builds the binary only for the specified module.
60
      Possible values for <module> are:
61
        - DiWheelDrive
62
        - PowerManagement
63
        - LightRing
64
65
66
EXAMPLES:
67
68
  >$$ make DiWheelDrive
69
      This command will generate the binary file for the DiWheelDrive module.
70
71
  >$$ make DiWheelDrive LightRing
72
      This command will generate the binary files for the two modules
73
      DiWheelDrive and LightRing.
74
75
  >$$ make flash -j
76
      This command will first build all missing binary files and flash all
77
      modules as soon as the binaries are ready.
78
      By the additional argument '-j' the build process will be parallelized.
79
80
  >$$ make clean && make all && make flash
81
      This command will first clean all thee projects. In a second step the
82
      binaries for al three modules are build from scratch. Finally all modules
83
      are updated with the latest software.
84
      The following command can be used as a shorter and faster version:
85
          >$$ make clean && make flash -j
86
87
################################################################################
88
endef
89
export HELP_TEXT
90
91
OS_BASE_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
92
93
help:
94
	@echo "$$HELP_TEXT"
95
	@exit
96
97
include $(OS_BASE_DIR)/os/modules/Makefile