home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / program / compiler / nasm20b / nasm_src / doc / readme < prev    next >
Text File  |  1993-01-19  |  5KB  |  130 lines
  1.  
  2.  
  3.  
  4.                This is NASM V2.0 from 1.Dez.1992
  5.  
  6.  
  7.  
  8.    NASM is a cross-development package for 6502 computers.
  9.    It's target machinery is the Atari 8-bit line, but if I
  10.    understand the AppleII and C64 fileformat correctly. NASM
  11.    ought to be useable for them as well (with some limitations),
  12.    with the use of the the XTRCTBIN program.
  13.    
  14.    Binaries for Atari ST computers ought to be supplied with this
  15.    README file. This development system runs on UNIX, MSDOS (?) 
  16.    and AMIGA as well. (UNIX, as tested on HPUX)
  17.  
  18.    Read INSTALL for further installation hints. Read CHANGES.TXT for
  19.    info, what has happened since last time.
  20.    Please do also read COPYRITE. 
  21.    If your having problems, cause there are little ^Ms everywhere, 
  22.    then "make -f makefile.nix to_us" first. 
  23.    To get rid of the ^Ms in crlf155.c use gnuemacs or somesuch and
  24.    type the following
  25.  
  26.    [META]-[X] replace-string [CTRL]-[Q] [CTRL]-[M] [RETURN] [RETURN]
  27.  
  28.    IF you have lost "localdef.h" somehow, possibly 'coz `make' or
  29.    `portable' killed it use this:
  30.       #define _WORD short
  31.       #define _LONG long
  32.       #define _BYTE char
  33.    as a starting point.
  34.  
  35.    If you want to port this to some other machine, please
  36.    read HACK.TXT. 
  37.    
  38.    At run-time NASM65 needs at least 300K of RAM. If you
  39.    don't have that much room to spare recompile NASM65
  40.    with smaller parameters in NMALLOC (won't help you
  41.    very much though, excepting the I/O buffer) or a smaller 
  42.    stack size.
  43.  
  44.    Sorry about the lack of quality in the documentation,
  45.    but you should consider yourself lucky to get anything
  46.    at all (har har). Actually as it now stands NASM65.TXT
  47.    is pretty good for my standards, the rest of the manuals
  48.    are still preliminary.
  49.    The information is not terribly well organized,some
  50.    problems you might encounter may be dealt with somewhere in
  51.    the documentation, where you least expect it. Some
  52.    basic knowledge about compiler/assembler construction may
  53.    not be entirely useless.
  54.  
  55.    Also my apologies for the less than perfect way the archives
  56.    are put together, but I rather use a dumb make script then
  57.    doing everything by hand.
  58.    
  59.    NASM65 hasn't been as rigidly tested as commercial soft-
  60.    ware (hell I'am doing this alone). I did assemble MYDOS
  61.    f.i. with it (in the runnable mode) and the object files did
  62.    match (except that NASM doesn't generate superflous
  63.    headers). Bugs were mostly found, while writing code and
  64.    wondering, why perfectly reasonable programs crashed. Oh
  65.    well, there are probably some techniques & features, that I
  66.    haven't thought off, which NASM may not handle correctly..
  67.    in this case, please send me a BUG report. A good bug
  68.    report should include:
  69.  
  70.    Version/Revision[/Platform (porter if possible)]
  71.    .S65 Source, which didn't work. (on DISK or via EMAIL)
  72.    Some comments, why you think this is a BUG. (Like: "it bombed")
  73.    Pricey gifts... (har har)
  74.  
  75.    The library contains up till now only some coding examples for
  76.    library routines. Some routines may not yet WORK!! 
  77.    The libraries are *primarily* included to show you how to possibly 
  78.    setup your own libraries. If they are of any use to you -fine-, but 
  79.    these are more of a bonus than anything else.
  80.  
  81.    Please do tell me what you would like to see improved with NASM,
  82.    use the address in the copyrite notice. Some feedback is also very
  83.    helpful to increase likeliness of further improvements.
  84.  
  85.    I hope you don't mind the occasional rather unconventional
  86.    error message. Take it with humor...
  87.  
  88.    For those who have a non-language dependent preprocessor, you might
  89.    take a look at NASM.C, which contains an enveloping program for
  90.    one preprocessor and the NASM65 assembler. This hasn't been really
  91.    finished, but should work nevertheless.
  92.    
  93.               Nat!
  94.  
  95.  
  96.  
  97.  
  98.    A P P E N D I X      ( random thoughts )
  99.    
  100.  
  101.    P.S.  If there are TABs in the source, they are set at three spaces not
  102.          eight. Output TABs are assumed to be eight!
  103.    
  104.  
  105.    Documentation is missing for the following files.
  106.  
  107.    1. CHKFFFF  shows segmentation of regular 8-Bit binaries
  108.  
  109.    2. XTRCTBIN extracts the raw binary data from  " " "
  110.                with the -f option it fills in the gaps. 
  111.                Non Atari users take note (har har :
  112.                 · With the -c option XTRCTBIN oughta convert the
  113.                   Atari binary into C64 format
  114.                 · With the -a option XTRCTBIN oughta convert the
  115.                   Atari binary into ProDOS AppleII format
  116.  
  117.    3. DEMAC65  converts a MAC65 tokenized file into ASCII
  118.  
  119.    4. DISASM65 (uncleverly) disassembles binary load files (.COM),
  120.                bootsectors, SDX drivers and NASM65 object files.
  121.  
  122.    5. CRLF155  converts ATASCII files to ASCII and backwards and more...
  123.    
  124.  
  125.    All of the above have a built in verbose help, type f.e.
  126.         CHKFFFF -help.
  127.    Some programs give their version number with -v.
  128.    All of the programs show their compile date with -:
  129.  
  130.