LUFA/Build/DMBS/Readme.md

   1 DMBS - Dean's Makefile Build System
   2 ===================================
   3
   4
   5 Project Overview
   6 ----------------
   7
   8 GNU Make is scary, and it's tough to get the rules right sometimes. Many
   9 projects get by via simple copy-pasting of old makefiles, resulting in many
  10 redundant copies of the same old rules. DMBS aims to solve this by providing a
  11 simple modular set of makefiles which can be included by your project to quickly
  12 add various build functionality.
  13
  14 This aims to replace the old WinAVR "mfile" makefile template, giving better
  15 functionality and much simpler user makefiles.
  16
  17
  18 Benefits:
  19 ----------------
  20
  21 Apart from much simpler, cleaner makefiles DMBS carries the aim of making the
  22 process of troubleshooting build issues a little easier. Lots can go wrong, so
  23 DMBS tries to sanity check its inputs wherever possible, and produce
  24 human-readable error messages. Forgotten to set a variable? Get a
  25 `Makefile {X} value not set.` message, rather than a possibly unrelated message.
  26 Have the wrong filename? See `Source file does not exist: {X}` rather than the
  27 infamous `No rule to make target {X}` message.
  28
  29
  30 Use:
  31 ----------------
  32
  33 A template user makefile is provided in the `Template` directory. DMBS modules
  34 are included via a GNU Make `include` directive. While the DMBS `core` module is
  35 always required, you can pick and choose what other modules you wish to add to
  36 your user project.
  37
  38 [See here for the documentation on the individual modules provided by DMBS.](DMBS/Modules.md)
  39
  40 Here's an example user makefile:
  41
  42         MCU          = atmega128
  43         ARCH         = AVR8
  44         F_CPU        = 8000000
  45         OPTIMIZATION = s
  46         TARGET       = Template
  47         SRC          = $(TARGET).c
  48         CC_FLAGS     =
  49         LD_FLAGS     =
  50
  51         # Default target
  52         all:
  53
  54         # Include DMBS build script makefiles
  55         DMBS_PATH   ?= ../DMBS
  56         include $(DMBS_PATH)/core.mk
  57         include $(DMBS_PATH)/gcc.mk
  58         include $(DMBS_PATH)/cppcheck.mk
  59         include $(DMBS_PATH)/doxygen.mk
  60         include $(DMBS_PATH)/dfu.mk
  61         include $(DMBS_PATH)/hid.mk
  62         include $(DMBS_PATH)/avrdude.mk
  63         include $(DMBS_PATH)/atprogram.mk
  64
  65 Each DMBS module can optionally supply one or more Make variables and macros,
  66 which you can reference in your user makefile. Additionally, modules can require
  67 one or more variables to be set by the user makefile, with (in some cases) sane
  68 defaults used if left out.
  69
  70 As modules are added, you can get a list of available targets by simply typing
  71 `make help` from the command line. This will produce a formatted list of targets
  72 as well as mandatory and optional variables and exposed variables and macros.
  73
  74
  75 License
  76 ----------------
  77
  78 DMBS is released into the public domain, making is suitable for use everywhere,
  79 by everyone. Contributions are greatly appreciated however, in order to make
  80 DMBS better for everyone.
  81
  82 The actual license text is as follows:
  83
  84         This is free and unencumbered software released into the public domain.
  85
  86         Anyone is free to copy, modify, publish, use, compile, sell, or
  87         distribute this software, either in source code form or as a compiled
  88         binary, for any purpose, commercial or non-commercial, and by any
  89         means.
  90
  91         In jurisdictions that recognize copyright laws, the author or authors
  92         of this software dedicate any and all copyright interest in the
  93         software to the public domain. We make this dedication for the benefit
  94         of the public at large and to the detriment of our heirs and
  95         successors. We intend this dedication to be an overt act of
  96         relinquishment in perpetuity of all present and future rights to this
  97         software under copyright law.
  98
  99         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 100         EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 101         MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 102         IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 103         OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 104         ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 105         OTHER DEALINGS IN THE SOFTWARE.
 106
 107         For more information, please refer to <http://unlicense.org/>