Statistics
| Branch: | Tag: | Revision:

amiro-os / Makefile @ 3940ba8a

History | View | Annotate | Download (4.353 KB)

1 e545e620 Thomas Schöpping
################################################################################
2
# AMiRo-OS is an operating system designed for the Autonomous Mini Robot       #
3
# (AMiRo) platform.                                                            #
4 84f0ce9e Thomas Schöpping
# Copyright (C) 2016..2019  Thomas Schöpping et al.                            #
5 e545e620 Thomas Schöpping
#                                                                              #
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 84f0ce9e Thomas Schöpping
# Copyright (c) 2016..2019  Thomas Schöpping                                   #
30 e545e620 Thomas Schöpping
#                                                                              #
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 d8ed8c1c Thomas Schöpping
  <module>:
52
      Builds the binary only for the specified module.
53
54
  flash_<module>:
55
      Builds the binary for the specified module and flashes it to the hardware.
56 e545e620 Thomas Schöpping
57
  clean:
58
      Deletes all temporary and binary files of all modules.
59
60 d8ed8c1c Thomas Schöpping
  clean_<module>:
61
      Deletes all temporary and binary files of the specified module.
62 e545e620 Thomas Schöpping
63
64
EXAMPLES:
65
66 2bb3bd89 Thomas Schöpping
  >$$ make DiWheelDrive_1-1
67
      This command will generate the binary file for the DiWheelDrive module
68
      (version 1.1).
69 e545e620 Thomas Schöpping
70 2bb3bd89 Thomas Schöpping
  >$$ make DiWheelDrive_1-1 LightRing_1-0
71 e545e620 Thomas Schöpping
      This command will generate the binary files for the two modules
72 2bb3bd89 Thomas Schöpping
      DiWheelDrive (version 1.1) and LightRing (version 1.0).
73 e545e620 Thomas Schöpping
74 d8ed8c1c Thomas Schöpping
  >$$ make all -j
75
      This command will first build missing binary files for all modules that
76
      are found in the 'modules/' folder.
77 e545e620 Thomas Schöpping
      By the additional argument '-j' the build process will be parallelized.
78
79 d8ed8c1c Thomas Schöpping
  >$$ make flash_DiWheelDrive_1-1
80
      This command will build the binary for the DiWheelDrive module
81
      (version 1.1) only if required, and flash it to the hardware.
82
83
  >$$ make clean; make all; make flash_DiWheelDrive_1-1
84
      This command will first clean all projects. In a second step the binaries
85
      for all modules are build from scratch. Finally the DiWheelDrive module
86
      (version 1.1) is updated with the latest software.
87 e545e620 Thomas Schöpping
88
################################################################################
89
endef
90 5d7e6f9e Thomas Schöpping
91
.PHONY: help
92 e545e620 Thomas Schöpping
93 870f74ac Thomas Schöpping
OS_BASE_DIR := $(dir $(lastword $(MAKEFILE_LIST)))
94 e545e620 Thomas Schöpping
95
help:
96 a7e67622 Thomas Schöpping
	$(info $(HELP_TEXT))
97 e545e620 Thomas Schöpping
	@exit
98
99 a7e67622 Thomas Schöpping
include $(OS_BASE_DIR)/modules/Makefile