USAGE.txt 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. This zipfile contains:
  2. - Binaries resulting from the build
  3. vdptest.cas
  4. vdptest.bas
  5. vdptest.bin
  6. vdptest1.dsk (1-side 360K floppy image)
  7. vdptest2.dsk (2-side 720K floppy image)
  8. - Source code
  9. vdptest.asm
  10. sysdefs.equ.asm
  11. main.code.asm
  12. main.bss.asm
  13. im2setup.equ.asm
  14. im2setup.code.asm
  15. frametime.code.asm
  16. frametime.bss.asm
  17. syncvint.code.asm
  18. test-ack-timing.code.asm
  19. test-ack-timing.bss.asm
  20. loadertpl.py (generates BASIC loader for .cas or .dsk as appropriate)
  21. - Documentation
  22. USAGE.txt (this file)
  23. LICENSE.md (Expat License, the license that applies to the code)
  24. - Build makefile
  25. Makefile
  26. - Auxiliary Python programs used to build the output
  27. asc2cas.py
  28. asc2cld.py
  29. raw2cas.py
  30. raw2bin.py
  31. - Blank disk images
  32. blank1.dsk.gz (1-side 360K)
  33. blank2.dsk.gz (2-side 720K)
  34. Requisites to build:
  35. To build using Makefile, you need GNU make.
  36. To assemble, you need Pasmo.
  37. To create the .cas image or the .bin disk file, you need Python 3 and cat.
  38. To automatically build the disk images, you need mtools and gzip.
  39. To create the .zip file, you additionally need rm and zip.
  40. To clean up the generated files, you need rm.
  41. Building generates some auxiliary files:
  42. vdptest.raw
  43. vdptestc.sym
  44. vdptestd.sym
  45. loader.cld
  46. loader.cas
  47. These files are not necessary once the build is complete, but re-running
  48. 'make' may cause them to be generated again.
  49. Usage:
  50. To build everything, type: make
  51. Other targets: make zip, make bas, make bin, make cas, make dsk, make clean
  52. To clean the directory and leave only the build requisites and sources,
  53. type: make clean
  54. To run it in a real MSX, you can use this with a cassette recorder or a
  55. floppy drive.
  56. Currently it only runs on a 16K+ machine. If run from floppy, disable the
  57. second drive by keeping CTRL pressed during boot.
  58. Usage with a cassette recorder:
  59. vdptest.cas is usable by an emulator, but in order to write it to tape,
  60. you need to convert it first to .wav format, then play that .wav while
  61. you record in the cassette recorder.
  62. Tools that can convert the .cas file to .wav are not included. You can
  63. use cas2wav from Vincent Van Dam's castools, or imgtool which comes with
  64. MAME/MESS.
  65. castools can be found here: https://github.com/joyrex2001/castools
  66. With cas2wav:
  67. cas2wav vdptest.cas vdptest.wav
  68. With imgtool (untested):
  69. imgtool get fmsx_cas vdptest.cas vdptest.wav
  70. Either use vdptest.cas and cas2wav to generate a tape, or vdptest.bas
  71. Usage with a floppy drive:
  72. Write vdptest.bas and vdptest.bin to a floppy and use RUN"vdptest.bas"
  73. The pre-built disk images vdptest1.dsk and vdptest2.dsk are provided for
  74. convenience.