docs/empty_config.mk

   1 #
   2 # $Id:$
   3 #
   4 # Copyright (C) 1999 by Matteo Cavalleri
   5 #
   6
   7 ## This is an empty local config.mk file. You should fill
   8 ## the required fields, copy it to your class directory
   9 ## and rename it to "config.mk".
  10 ## Detailed explanations of the various variables are
  11 ## given below. Please be sure to give the right value
  12 ## to all the variables, or you may get unpredictable
  13 ## results!!
  14 ##
  15 ## We also suggest you to delete the lines beginning with
  16 ## two '##' like the ones you are reading now. This will
  17 ## make the processing of this file faster since make
  18 ## won't have to strip tons of comments.
  19
  20 ###########################################################
  21 # your stuff
  22 #
  23
  24 ##
  25 ## CLASSLIB is the name of the compiled class, like
  26 ## "label.image" or "listview.gadget", etc.
  27 ## This is required by the makefile. It will also
  28 ## define the symbol "NAME" with this variable's
  29 ## value so that it can be used in your source.
  30 ##
  31 ## example:
  32 ##
  33 ## CLASSLIB := button.gadget
  34 ##
  35 CLASSLIB :=
  36 ##
  37 ## CLASSSRC is the name of the source code of
  38 ## your class, extension included.
  39 ## This is required by the Makefile.
  40 ##
  41 ## example
  42 ##
  43 ## CLASSSRC := ButtonGClass.c
  44 ##
  45 CLASSSRC :=
  46 ##
  47 ## DEMOSRC is the name of the source code
  48 ## of your demo program, extension included.
  49 ## This is required by the Makefile.
  50 ##
  51 ## example
  52 ##
  53 ## DEMOSRC := ButtonGDemo.c
  54 ##
  55 DEMOSRC  :=
  56 ##
  57 ## SUBDIR is the directory name where your class
  58 ## will be copied when you will execute the
  59 ## 'install' target. It must be "images" if your
  60 ## class is a BOOPSI image, "gadgets" if your class
  61 ## is a BOOPSI gadget or just an empty string if
  62 ## your class is a general BOOPSI object.
  63 ##
  64 ## example
  65 ##
  66 ## SUBDIR := gadgets
  67 ##
  68 SUBDIR   :=
  69
  70
  71 ###########################################################
  72 # class version information
  73 #
  74
  75 ##
  76 ## CLASSVER is the version number of your class library
  77 ## e.g. if your library is version 1.2 CLASSVER is 1.
  78 ## It is required to compile the library startup code,
  79 ## and will also be used to define a symbol named VERSION,
  80 ## so that you can use it in your source code.
  81 ##
  82 ## example
  83 ##
  84 ## CLASSVER := 1
  85 ##
  86 CLASSVER  :=
  87 ##
  88 ## CLASSREV is the revision number of your class library
  89 ## e.g. if your library is version 1.2 CLASSREV is 2.
  90 ## It is required to compile the library startup code,
  91 ## and will also be used to define a symbol named VERSION,
  92 ## so that you can use it in your source code.
  93 ##
  94 ## example
  95 ##
  96 ## CLASSREV := 2
  97 ##
  98 CLASSREV  :=
  99 ##
 100 ## CLASSDATE is the date of your class library. It follow
 101 ## the standard AmigaOS rules, so it must be enclosed in
 102 ## parenthesis and have the following format: Day.Month.Year
 103 ## It is used to define a symbol named DATE so that you can
 104 ## use it in your source code.
 105 ##
 106 ## example
 107 ##
 108 ## CLASSDATE := (6.4.99)
 109 ##
 110 CLASSDATE :=
 111
 112
 113 ###########################################################
 114 # variable to make the linked library version
 115 #
 116
 117 ##
 118 ## PRV variables is used to compile the class as a linked
 119 ## library instead of the shared version. It is simply
 120 ## used to define a preprocessor simbol with the name
 121 ## you give here.
 122 ## It's up to you to create a class that can be compiled
 123 ## as a shared or static library depending on the
 124 ## definition of this symbol. The current makefile
 125 ## define it for a couple of targets, like 'debug', so
 126 ## we suggest you to implement this features. It's very
 127 ## easy and in most cases requires just some copy & paste
 128 ## from existing classes. Look at them or ask in the
 129 ## OpenBoopsi mailing list if you need a more detailed
 130 ## explanation.
 131 ##
 132 ## example
 133 ##
 134 ## PRV := PRIVATE_GADGETCLASS
 135 ##
 136 PRV :=
 137