README
1============================
2DASM 2.20.14.1 readme
3============================
4
5 Welcome to DASM, a versatile macro assembler with support for several
6 8-bit microprocessors including MOS 6502 & 6507; Motorola 6803, 68705,
7 and 68HC11; Hitachi HD6303 (extended Motorola 6801) and Fairchild F8.
8
9 Download the latest compiled & packaged version of DASM from here:
10 https://github.com/dasm-assembler/dasm/releases/latest
11
12 For a comprehensive User Guide to using DASM, grab:
13 https://raw.githubusercontent.com/dasm-assembler/dasm/master/docs/dasm.pdf
14
15 Other documentation is at:
16 https://raw.github.com/dasm-assembler/dasm/master/doc/dasm.txt
17
18 This file describes the DASM source distribution, how to compile DASM,
19 and where to get more information.
20
21 DASM's homepage is https://dasm-assembler.github.io/
22
23---------------
24Binary Releases
25---------------
26
27 In case you're running Windows, macOS or Linux and just want to download
28 and use DASM, please go directly to the releases:
29 https://github.com/dasm-assembler/dasm/releases
30
31----------------
32The Distribution
33----------------
34
35 The DASM distribution contains the following important files and
36 directories of interest to all users:
37
38 docs/ Documentation and manuals
39 docker/ Contains files & instructions to create a docker
40 image to run a 'dasm build machine' container
41 machines/ Support files for various 8-bit machines
42 LICENSE GNU General Public License
43 NEWS Recent changes to DASM
44 README The file you are reading right now :-)
45
46 In addition, developers are going to be interested in the following
47 files and directories:
48
49 src/ Source code for DASM and related tools
50 test/ Test cases for DASM and related tools
51 (as of release 2.20.11 the test framework is incomplete)
52 bin/ This is were the compiled executables for DASM and
53 related tools will be placed after you do a 'make'
54 research/ A directory where we keep experiments
55 ChangeLog Source level changes to DASM
56 Makefile Makefile to build DASM executables, run tests, and
57 create distributions
58
59 Even more files for developers are available from the DASM GitHub
60 repository, see https://github.com/dasm-assembler/dasm for details.
61
62---------
63Compiling
64---------
65
66 If you are using DASM on a Unix system, you should be able to simply
67 give the command
68
69 make
70
71 in the root directory of the DASM distribution and DASM should build.
72 A bin/ directory containing DASM executables will be created as part
73 of this process. You can also give the command
74
75 make test
76
77 to run all the test cases that come with the distribution. Note that
78 as of release 2.20.11 the test framework is incomplete and probably
79 only remotely comprehensible for developers. :-/ The often-used
80
81 NOTE: Several compiler warnings will be displayed during the build
82 process. We are confident that you can ignore these warnings.
83 They will be dealt with in a future release. (And if you know
84 how to fix them reliably, we welcome your contributions!)
85
86 DASM has been built and tested successfully on recent versions of Linux,
87 macOS and Windows.
88
89 If you have successfully built and tested DASM on a different machine
90 or operating system, we would love to hear about it.
91
92----------
93Using DASM
94----------
95
96 The simplest way to get a brief introduction to DASM is to run the
97 bin/dasm executable without options, which will print a short help
98 message summarizing all available options.
99
100 For a comprehensive User Guide to using DASM, grab:
101 https://raw.githubusercontent.com/dasm-assembler/dasm/master/docs/dasm.pdf
102
103 Documentation for using DASM to produce code for the F8 processor
104 is currently in the directory machines/channel-f/ but will be
105 integrated into the main documentation in the future.
106
107 Bugs? Feature requests?
108 Please report bugs or feature requests on our dasm project page.
109 See https://github.com/dasm-assembler/dasm
110 All versions of dasm are written in C. If you want to contribute
111 we encourage you to fork dasm and send us pull requests!
112
113 There is also a vibrant community of developers writing games and
114 demos for the Atari 2600 VCS using DASM. The mailing lists for the
115 Stella emulator are a particularly useful resource for DASM users,
116 not only those intent on programming for the VCS.
117
118--------
119Legalese
120--------
121
122 the DASM macro assembler (aka small systems cross assembler)
123
124 Copyright (c) 1988-2002 by Matthew Dillon.
125 Copyright (c) 1995 by Olaf "Rhialto" Seibert.
126 Copyright (c) 2003-2008 by Andrew Davie.
127 Copyright (c) 2008-2015 by Peter H. Froehlich.
128 Copyright (c) 2019-2020 by the DASM team.
129
130 This program is free software; you can redistribute it and/or modify
131 it under the terms of the GNU General Public License as published by
132 the Free Software Foundation; either version 2 of the License, or
133 (at your option) any later version.
134
135 This program is distributed in the hope that it will be useful,
136 but WITHOUT ANY WARRANTY; without even the implied warranty of
137 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
138 GNU General Public License for more details.
139
140 You should have received a copy of the GNU General Public License along
141 with this program; if not, write to the Free Software Foundation, Inc.,
142 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
143
144