ZSpec

Z80 code tester and verificator
Explore the docs »

View Examples · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About ZSpec

Briefly – it is pretty pourly and carelessly written initial implementation tests for Z80 project's .

Perhaps, because of my long time work with high-level languages and web-projects I got a thought: why we doesn't have tests and specifications for Z80 projects? (May be they are exists, but I cannot found good one).

So I decided to make this one mainly with intention if someone wiser then me came and make something like this but much better.

(back to top)

Built With

• Z80 emulator library
• TomlPlusPlus parser library
• Command line parser library
• Docker cross-compilers suit
• Toml
• C++ compiler

(back to top)

Getting Started

• Write some library with functions using you lovely compiler: c or asm or something other
• Compile it, export binary image and labels file
• Write specification, using simple language based on Toml syntax
• Run zspec path/to/ypur-zspec.toml
• You have results of calling your code in tradition green/red style

BTW it is also possible run just one test from a few:

zspec path/to/ypur-zspec.toml:5

it will run 5-th test, skipping others.

Prerequisites

You need to have c++ compiler to build this project.

Or, instead you could take compiled version from releases folder.

Installation

• make in project folder to build executable.
• copy executable somwhere to your PATH

(back to top)

Usage

WIP

For more examples, please refer to the Examples

(back to top)

Roadmap

• Add ability to load binary file for memory comparing expectations
• Memory series expectations
• Add ports expectations
• Add command line params
• More documentation and examples

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Yury Batenko - jurbat@gmail.com

Project Link: https://github.com/svenyurgensson/zspec

(back to top)

Acknowledgments

(back to top)