home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / LA / LA024.ZIP / README.SUP < prev    next >
Text File  |  1990-08-14  |  17KB  |  420 lines
  1. IMPORTANT NOTE:  SMAK.EXE, MS.EXE, and BOR.EXE are self - extracting 
  2. compressed archives, not executable files.  The only executable file that
  3. can be run before installation is INSTALL.EXE.
  4.  
  5. Thank you for using SUPER MAKE.  I hope you will like using it.  
  6.  
  7. You can conveniently read this file from within INSTALL, and print it to 
  8. your printer (if installed on lpt1) if you want to.
  9.  
  10. The topics covered in this file are:
  11.  
  12.                         1.  Shareware
  13.                         2.  Installation
  14.                         3.  Manual (How to view and print out)
  15.                         4.  Settings
  16.                         5.  Compiler Support
  17.                         6.  The future
  18.                         7.  Product Support
  19.                         8.  Printing Utilities
  20.                         9.  The sample files
  21.                         10. A note on building libraries
  22.  
  23. 1. SHAREWARE:
  24.  
  25. The advantage to using shareware is that you get to "try before you buy"
  26. the program.  There are many excellent shareware packages, and I hope 
  27. you will feel SUPER MAKE is one of them.  If you do, and you use the
  28. program beyond 30 days, you must register your copy.
  29.  
  30. Registration has many advantages:
  31.  
  32. 1.  You get the latest version of SUPER MAKE on disk with a printed manual.
  33.  
  34. 2.  The version you recieve has the registration reminder screens removed.
  35.  
  36. 3.  You get a serial number that entitles you to technical support.
  37.  
  38. 4.  You help support a programmer who, like yourself, is trying to make
  39.     a living.  By doing this you help support the program itself, because
  40.     I will have the ability to continue improving it.
  41.  
  42. 5.  You will recieve upgrade notices and you will be able to upgrade at
  43.     a discount.
  44.  
  45. Registering SUPER MAKE is $55.  Such a deal!  See the file reg.frm for a
  46. registration form (you may do this by mail, or by plastic-- EmmaSoft 
  47. accepts phone registrations if you have Master Card or Visa).
  48.  
  49. SUPER MAKE was written by Dan Veaner, an ASP (Association of Shareware 
  50. Professionals) member.  For more information about shareware and the ASP 
  51. see chapter 11 in the manual.  See "Product Support" below to see how to
  52. reach me.
  53.  
  54. 2. INSTALLATION:
  55.  
  56. The following files MUST be on your distribution disk, or contained in
  57. the .zip file you recieved SUPER MAKE on.  If any of these are missing 
  58. PLEASE CONTACT EMMASOFT IMMEDIATELY (if any of these files are missing 
  59. you have recieved an unauthorized package.  To insure that you get a 
  60. complete version that is virus free you must have an authorized package.
  61. You may get the distribution disk for a small fee from EmmaSoft or from
  62. authorized shareware distributers, or get the .zip file from several 
  63. bulletin boards:
  64.  
  65.  
  66.     File Name               Description
  67.  
  68.     SMAK     EXE            SUPER MAKE Files
  69.     MS       EXE            Microsoft Language Definition Files
  70.     BOR      EXE            Borland Language Definition Files 
  71.     INSTALL  EXE            Automatic Installation Program
  72.     README   SUP            This File
  73.     REG      FRM            Registration Form 
  74.     S        COM            Landscape Print Utility
  75.     SL       COM            Landscape Print Utility
  76.     VENDOR   DOC            File for Shareware Vendors
  77.     SUPER    INF            Brief Description of SUPER MAKE
  78.  
  79. SUPER MAKE needs about 420K on your hard disk.
  80.  
  81. You should use the automatic installation program to install SUPER MAKE.  
  82. It will copy the SUPER MAKE files to your hard disk, create directories, 
  83. if needed, set up an initialization file, and perform a few other tasks.  
  84.  
  85. To begin type:              INSTALL <Enter>
  86.  
  87. You really need a hard drive to use SUPER MAKE, but INSTALL.EXE will let
  88. you install to two floppies if you want to.  If you choose to do this you
  89. must have two formatted disks ready before you start.  
  90.  
  91. You MUST use INSTALL.EXE to create the initialization file needed by the 
  92. three programs.  This is an option (b) on the main Installation menu. Do
  93. not try to run any of the SUPER MAKE programs without creating this file
  94. (most likely your computer will crash).  
  95.  
  96. INSTALL.EXE checks to make sure there is enough room on the target disk
  97. before beginning the installation.
  98.  
  99. Just answer the questions you are asked as you go along.  If you change your
  100. mind INSTALL lets you change your answers before it begins installation.
  101.  
  102. NOTE:  You should let INSTALL create the directory that will hold SUPER MAKE 
  103. in most instances, even if the directory already exists (in which INSTALL 
  104. doesn't change it).  If you do NOT, the SUPER MAKE files are installed to the 
  105. root directory of your disk.
  106.  
  107. SUPER MAKE consists of three programs:
  108.  
  109.           SUPER MAKE                A make program
  110.           SUPER MAKE Editor         Automatically generates make and
  111.                                     other files
  112.           SUPER MAKE Help Facility  Used by maker, or can be used as
  113.                                     a stand alone program
  114.  
  115. Information for manual installers:
  116.  
  117. The Installation program will NOT make new directories or change your
  118. autoexec.bat file unless you explicitly give it permission to do so.
  119. The program does not touch your config.sys file or any other files on
  120. your computer.
  121.  
  122. On your disk there are two files, SMAK.EXE and SHLP.EXE.  These
  123. are self extracting files containing the SUPER MAKE Editor,
  124. SUPER MAKE and the SUPER MAKE Help Facility, and the help files needed by
  125. the three programs.  If you do not want to automatically install you may
  126. manually install by typing:  [progname][destination]  (where progname is
  127. SMAK or SHLP, and destination is the drive and directory you are
  128. installing to.  
  129.  
  130. There are two other files called MS.EXE and BOR.EXE.  These are  self-
  131. extracting files with sample language definition files for Microsoft and
  132. Borland users.  To get these files type:  MS [drive:\path] or 
  133. BOR [drive:\path].
  134.  
  135.  
  136. You MUST set the SUPERFILES variable in your DOS environment, and add 
  137. the SUPER MAKE directory to your PATH command from your AUTOEXEC.BAT FILE.  
  138. If you let INSTALL change your autoexec.bat file for you these commands are 
  139. put in automatically.  If not you should do two things:
  140.  
  141.   1.  Add the directory containing SUPER MAKE files to your path
  142.  
  143.   2.  Add this command:  SET SUPERFILES=C:\SUPER  (where "C:\SUPER is
  144.       the drive and directory containing your SUPER MAKE files).
  145.  
  146. IMPORTANT NOTE:   It is assumed in these documents that your compilers
  147. are kept in directories that are included in your PATH command.  If they
  148. are not SUPER MAKE will not be able to call them.
  149.  
  150.  
  151. 3. MANUAL:
  152.  
  153. You may view the manual on line in the SUPER MAKE Editor, or when using
  154. the Help Facility.  Most of the manual may be viewed in this way.  For
  155. the complete manual you will want a printed manual.  To get a printout 
  156. of the manual either go into the toolbox menu in the SUPER MAKE Editor, 
  157. or call the Help facility as follows:  SMH MANUAL.  You will see a table 
  158. of contents on your screen.
  159.  
  160. Press Ctrl-p.  You are now prompted for a printer or filename.  If you
  161. want to print directly to your printer type Enter (for lpt1), or you 
  162. may type lpt2, com1, or com2 if you printer is attached to one of these
  163. ports.  If you want to print to a file (for importation into a word
  164. processor, or to print later) type a file name (I always type "manual").
  165.  
  166. What's in the printed version that isn't in the on-line version?  Mostly
  167. example files, although there are one or two other things (like an index).
  168.  
  169. By the way, the manual is about 60 pages long.
  170.  
  171. 4.  SETTINGS:
  172.  
  173. SUPER MAKE attempts to automate the process of program development as
  174. much as possible.  You should be aware that the following are set for
  175. SUPER MAKE as well as the SUPER MAKE Editor in the Setup Menu of
  176. the SM Editor:
  177.  
  178.  
  179. In "Super Make Files":
  180.  
  181.              1.  Directory to put .OBJ files 
  182.              2.  Directory to put executable files
  183.  
  184. And in "Defaults":
  185.  
  186.              3.  Brand of your compiler(s), linker, librarian
  187.  
  188. The thinking behind this is that these things won't change very often
  189. for the average user.  You may set these once and then forget about them.
  190.  
  191. If, however, you use several brands of compiler you will want to set
  192. the Brand of your Compiler each time you switch.
  193.  
  194.  
  195. 5.  COMPILER SUPPORT
  196.  
  197. At the moment SUPER MAKE can be configured for two brands of compiler(s):
  198. Microsoft and Borland.  When you install using INSTALL.EXE you choose to set 
  199. it up for one of these.
  200.  
  201. You should be aware that SUPER MAKE puts things in a slightly different order 
  202. for Microsoft commands than it does for Borland ones.  (I'll explain this in 
  203. a moment.)
  204.  
  205. If you use products other than Microsoft and Borland and would like them
  206. supported by SUPER MAKE I'll be happy to write them into the program if
  207. you will send me the following information:
  208.  
  209. 1.  The format of your compiler's commands
  210.     
  211.     Example from MS C:  
  212.  
  213.       cl [flags] [source_file_name.c]
  214.  
  215. 2.  The format of your linker's commands
  216.  
  217.     Example from MS LINK:  
  218.  
  219.       link [file1.obj file2.obj],[exename.exe],[mapname.map],[lib1 lib2]
  220.  
  221.     Dos your linker use command files?  If so give an example of the
  222.     format.
  223.  
  224.     Example from MS LINK:
  225.  
  226.       link [flags] @resname.res
  227.  
  228.     Also include an example and explanation of the format of the
  229.     response file.
  230.  
  231.     Example from MS LINK:
  232.  
  233.          OBJ1+          Object files to be linked
  234.          OBJ2+
  235.          EXENAME        Name of executable file
  236.          MAPNAME        Name of Map file
  237.          LIB1+          Library names
  238.          LIB2
  239.          nul.def        Definition File Name 
  240.  
  241. 3.  All the same information for your librarian.
  242.  
  243. It is important that you send both a description of compiler, linker, 
  244. librarian commands AND examples.  Also if I get confused I may want
  245. to call or write you, so please include that information as well.
  246.                               --------
  247.  
  248. Here is the formatting information for Microsoft and Borland products:
  249.  
  250.      Command line looks like:
  251.  
  252.                  cl (L1) sample.c
  253.  
  254.      Commands are built as follows:
  255.  
  256.   
  257. Microsoft:     cl  L1CO  L1Mx (L1D or L1ND) L1F1 L1F2 sample.c
  258. Borland:       tcc L1CO  L1Mx (L1D or L1ND) L1F1 sample.c L1F2
  259.  
  260. Using the second general commands flags macro at the end allows for
  261. Borland specific command structure.
  262.  
  263. Microsoft Linker and Librarian always use Response files.
  264.  
  265. Borland Linker always uses 2 command files.  The first (filename.boj) has
  266. the names of the object files to be linked (this is automatically generated
  267. by the SUPER MAKE Editor when set to Borland and generating a make file).
  268. The second is the library command file (generated three times for the
  269. three memory models currently being used, and called filename.lrs, 
  270. filename.lrm, or filename.lrl.).
  271.  
  272. When generating a SUPER MAKE file for Borland products some linker and 
  273. librarian commands are appended to the memory model macros in order to
  274. end up with the proper command structure.
  275.  
  276. 6.  THE FUTURE
  277.  
  278. The reason I wrote SUPER MAKE was to make life easier for myself and other
  279. programmers.  If there are features you would like in SUPER MAKE please
  280. don't hesitate to contact me.  Please don't be angry at the program for
  281. not doing something you want it to do.  Instead let me know what you want
  282. and there is a very good chance it will be included.  I try to include as
  283. many users' suggestions into my programs as is reasonable (given the scope
  284. of the program).  So please keep those cards and letters coming!
  285.  
  286. If SUPER MAKE works with your compiler that is not listed in this file
  287. please let me hear from you.  I would be grateful for language definition
  288. files for your compiler.  If you send them (and they are not duplicates
  289. of others sent) I will include them in a future release of the product with
  290. appropriate credit to you.
  291.  
  292. 7.  PRODUCT SUPPORT
  293.  
  294. EmmaSoft does NOT support third party products.  For example, we don't
  295. give technical support for Microsoft C.  We do support our own products,
  296. and make every effort to make them happy, bug free programs.  We test our
  297. software rigorously before releasing it.  SUPER MAKE has been used in it's
  298. own development since there's been enough of it to work properly.  Every
  299. once in a while one of those pesky insects does get into a program, and
  300. bug reports are greatly appreciated from all users.
  301.  
  302. Technical support is ONLY available to REGISTERED users with a valid
  303. serial number (when you register you are sent the latest copy of SUPER
  304. MAKE with printed documentation, a valid serial number, and WITHOUT the
  305. shareware reminder messages that are built in to the unregistered version).
  306.  
  307. EmmaSoft is open 9 to noon, 1-5, M-F (and sometimes on Saturdays).  The
  308. address is:  EmmaSoft   PO Box 238   Lansing, NY 14882-0238.
  309.  
  310. The phone is  (607) 533-4685.
  311.  
  312. My CompuServe number is 71460,2644.
  313.  
  314. If you call and get the answering machine please leave a message.  If you
  315. want me to call you back please leave a number where I can call collect, 
  316. and some good times to reach you.
  317.  
  318. 8.  PRINTING UTILITIES
  319.  
  320. Two little printing utilities for the HP Laserjet have been included.  They
  321. are S.COM and SL.COM.  They both print a file in small letters in Landscape
  322. orientation.  I use them a lot to print out source code (that is wider
  323. than 80 characters).  
  324.  
  325. See appendix D in the manual (you'll need to print it out to get this) for
  326. instructions.
  327.  
  328. 9.  THE SAMPLE FILES
  329.  
  330. Included with this package is a set of sample files for C and assembly 
  331. language programmers to experiment with.  These consist of:
  332.  
  333.   SAMPLE.C         C Code
  334.   SAMPLE1.C        C Code
  335.   SAMPLEA.ASM      Assembly Code
  336.   SAMPLEA.OBJ      Object made from SAMPLEA.ASM for C Programmers without 
  337.                    an Assembler
  338.   SAMPLE.EXE       An executable version.
  339.  
  340. Users of other languages can easily write a few small files of sample code to
  341. experiment with.
  342.  
  343. SAMPLE.EXE is a multi moduled program using C and Assembly language.  It
  344. contains 5 functions: 2 in each C module, and one in the assembler module.
  345. To call it you type SAMPLE and two numbers (ex: SAMPLE 5 67).  It will
  346. add the numbers and report on whether it is exiting properly or with
  347. an error condition.
  348.  
  349. SAMPLEA.OBJ is provided for C programmers who do not have an assembler.  If 
  350. you simply don't want to mess around with the assembly language module you
  351. may deal with it in one of two ways, by slightly changing the code in 
  352. SAMPLE.C.  
  353.  
  354. Method one:  Define a macro as follows:  
  355.  
  356.                     #define smplad(a,b) ((a),(b))
  357.  
  358. Method two:  Replace the call to smplad (in the printf statement where it 
  359. says printf("\n%d + %d = %d",a,b,smplad(a,b));) with (a+b) (so you will 
  360. end up with printf("\n%d + %d = %d",a,b,(a+b);).
  361.  
  362. In either case delete the function declaration for smplad().
  363.  
  364. To get started, call the SUPER MAKE Editor (SME).
  365.  
  366. In the Setup Menu (alt-s) set SME to make SUPER MAKE files and Linker 
  367. Response files (See Chapter 5 of the manual for Setup Instructions).
  368.  
  369. Press Esc to get the main menu, then go into the Make menu (alt-m).
  370.  
  371. Type alt-p  (Pick Code Files)
  372.  
  373. Using your mouse or the arrow keys pick the drive and directory the sample
  374. source code files are on, and mark (+) the three files.
  375.  
  376. Type Esc to back out of the Drive/Directory/Files windows.
  377.  
  378. When the three file names are displayed highlight SAMPLE.C and press Esc.
  379.  
  380. Check that your macros are set the way you want them (alt-m).
  381.  
  382. Now make the files (alt-s).
  383.  
  384. If your SUPER MAKE files have been successfully generated you are ready to
  385. try the maker.  Press alt-q to quit SME.
  386.  
  387. To build the file type:    SM -1 sample <Enter>
  388.  
  389. (You use the small memory model because the assembly module is written in
  390. the small model).
  391.  
  392. Feel free to experiment.  In Setup in the SME you can set the drive and
  393. directory you want your object and/or executable files in.  Try different
  394. settings here, and see how SUPER MAKE handles your files.  
  395.  
  396. You may call SUPER MAKE from any directory, provided you give it the full
  397. path of the make file.  For example:  SM C:\CODE\SAMPLE <Enter>
  398.  
  399. 10. A NOTE ON BUILDING LIBRARIES
  400.  
  401. Because SUPER MAKE depends on response (command) files you may find building
  402. libraries minorly awkward using the Microsoft librarian.  What you need to do 
  403. is to build the library using the name you have chosen.  For each memory 
  404. model you build RENAME the final library.  For example if you are building 
  405. three versions of the MYLIB library you build it once for each memory model:
  406.  
  407.              sm -1 MYLIB
  408.  
  409. then rename the library for that model:
  410.  
  411.              ren MYLIB.LIB SMYLIB.LIB
  412.  
  413. Next type sm -e to erase the small model object files.
  414.  
  415. Now rebuild for the medium model:    sm -2 MYLIB
  416.  
  417. and rename the final file:    ren MYLIB.LIB MMYLIB.LIB
  418.  
  419. and so on.
  420.