git.sur5r.net Git - cc65/blob - samples/README

   1
   2 This directory contains sample programs for the cc65 compiler.
   3
   4 Below is a short description for each of the programs together with a list of
   5 the supported platforms.
   6
   7 Please note:
   8
   9   * The supplied makefile needs GNU make. It works out of the box on Linux
  10     and similar systems. If you're using Windows, consider installing Cygwin.
  11
  12   * The makefile specifies the C64 as the default target system, because all
  13     but one of the programs run on this platform. When compiling for another
  14     system, you will have to change the line that specifies the target system
  15     at the top of the makefile, specify the system with SYS=<target> on the
  16     make command line or set a SYS env var.
  17
  18
  19 List of supplied sample programs:
  20
  21 -----------------------------------------------------------------------------
  22 Name:           ascii
  23 Description:    Shows the ASCII (or ATASCII, PETSCII) codes of typed
  24                 characters. Written and contributed by Greg King
  25                 <gngking@erols.com>.
  26 Platforms:      All platforms with conio or stdio (compile time configurable).
  27
  28 -----------------------------------------------------------------------------
  29 Name:           diodemo
  30 Description:    A disc copy program written and contributed by Oliver
  31                 Schmidt, <ol.sc@web.de>. Supports single or dual disc copy.
  32 Platforms:      The program does depend on conio and dio (direct disk i/o),
  33                 so it does currently compile for the Atari and Apple ][
  34                 machines.
  35
  36 -----------------------------------------------------------------------------
  37 Name:           enumdevdir
  38 Description:    Enumerates all devices, directories and files. Written and
  39                 contributed by Oliver Schmidt, <ol.sc@web.de>.
  40 Platforms:      All systems with device enumeration and directory access
  41                 (currently the C64, the C128 and the Apple ][).
  42
  43 -----------------------------------------------------------------------------
  44 Name:           fire
  45 Description:    Another graphics demo written by groepaz/hitmen.
  46 Platforms:      The program is currently only running on the C64, but should
  47                 be portable to the C128 and CBM510 (and maybe more machines).
  48
  49 -----------------------------------------------------------------------------
  50 Name:           gunzip65
  51 Description:    A gunzip utility for 6502 based machines written by Piotr
  52                 Fusik <fox@scene.pl>.
  53 Platforms:      Runs on all platforms with file I/O (currently the Atari, the
  54                 Apple ][ and most Commodore machines).
  55
  56 -----------------------------------------------------------------------------
  57 Name:           hello
  58 Description:    A nice "Hello world" type program that uses the conio
  59                 console I/O library for output.
  60 Platforms:      Runs on all platforms that support conio, which means:
  61                 Apple ][, Atari, C16, C64, C128, CBM510, CBM610, PET, Plus/4
  62
  63 -----------------------------------------------------------------------------
  64 Name:           mandelbrot
  65 Description:    A mandelbrot demo using integer arithmetic. The demo was
  66                 written by groepaz/hitmen and converted to cc65 using TGI
  67                 graphics by Stephan Haubenthal.
  68 Platforms:      Runs on all platforms that have TGI support:
  69                 Apple ][, C64, C128, Oric Atmos, Geos and Lynx.
  70
  71 -----------------------------------------------------------------------------
  72 Name:           mousedemo
  73 Description:    Shows how to use the mouse.
  74 Platforms:      All systems with mouse and conio support:
  75                 C64, C128, CBM510, Atari, Apple ][
  76
  77 -----------------------------------------------------------------------------
  78 Name:           multidemo
  79 Description:    Shows how to combine multiple cc65 features incl. overlays
  80                 and extended memory drivers. Written and contributed by
  81                 Oliver Schmidt, <ol.sc@web.de>.
  82 Platforms:      All systems with an overlay linker config, disk directory
  83                 access and EMD support (currently the C64, the C128,
  84                 the Atari and the Apple ][).
  85
  86 -----------------------------------------------------------------------------
  87 Name:           nachtm
  88 Description:    Plays "Eine kleine Nachtmusik" by Wolfgang Amadeus Mozart
  89 Platforms:      All systems that have the Commodore SID (Sound Interface
  90                 Device):
  91                 C64, C128, CBM510, CBM610
  92
  93 -----------------------------------------------------------------------------
  94 Name:           overlaydemo
  95 Description:    Shows how to load overlay files from disk. Written and
  96                 contributed by Oliver Schmidt, <ol.sc@web.de>.
  97 Platforms:      All systems with an overlay linker config (currently the C64,
  98                 the C128, the Atari and the Apple ][).
  99
 100 -----------------------------------------------------------------------------
 101 Name:           plasma
 102 Description:    A fancy graphics demo written by groepaz/hitmen.
 103 Platforms:      The program needs a VIC, or a TED, so it runs on the following
 104                 systems:
 105                 C64, C128, CBM510, Plus/4
 106
 107 -----------------------------------------------------------------------------
 108 Name:           sieve
 109 Description:    Implements the "Sieve of Eratosthenes" as a way to find all
 110                 prime numbers in a specific number interval. Often used as
 111                 a benchmark program.
 112 Platforms:      All systems with conio and clock support:
 113                 Atari, C16, C64, C128, CBM510, CBM610, PET, Plus/4,
 114                 Apple ][ (without timing due to missing clock support)
 115
 116 -----------------------------------------------------------------------------
 117 Name:           tgidemo
 118 Description:    Shows some of the graphics capabilities of the "tiny graphics
 119                 interface".
 120 Platforms:      Runs on all platforms that have TGI support:
 121                 Apple ][, C64, C128, Oric Atmos, Geos and Lynx.