The first chapter provides an overview of the SidecarT project, explaining the projectโ€™s purpose, objectives, and the intended audience. The goal is to give readers a concise understanding of what the project entails and what it seeks to achieve.

Table of contents
  1. Project Overview
  2. Objective and Purpose
  3. Target Audience
  4. Contribution Guidelines
    1. ๐Ÿ“œ Licensing
    2. ๐Ÿž Reporting Bugs
    3. ๐Ÿ’ก Feature Requests
    4. ๐Ÿ’ป Code Contributions
    5. ๐Ÿ›  Hardware Contributions
    6. ๐Ÿ“š Documentation
    7. ๐Ÿ‘€ Review Process
    8. ๐Ÿ™Œ Thank You!

Project Overview

Welcome to SidecarT, your gateway to a harmonious blend of nostalgic computing with modern technological enhancements. This device is a cartridge ROM emulator meticulously designed for the Atari ST, STE, and Mega series. Itโ€™s built to ride the robust capabilities of the RP2040 microcontroller found in the Raspberry Pi Pico, offering a comprehensive and versatile emulation experience. Whether youโ€™re looking to dive back into the authentic experience of using retro machines or a developer eager to explore the vast possibilities of retro computing, SidecarT is your companion.

Key Highlights:

  • Versatile ROM Emulation: SidecarT provides a seamless experience in emulating both 64Kbyte and 128Kbyte ROMs, loaded effortlessly from a microSD card or via a Wi-Fi connection.
  • Real-time Interaction: It offers unparalleled real-time interaction with the cartridge bus, allowing users to read and write data on-the-fly, enhancing the emulation of various devices like hard disks, floppy disks, keyboards, and more.
  • Open Architecture: The open-source nature of SidecarT fosters innovation and creativity, letting the community expand its functionalities and explore new horizons in retro computing.
  • Evolving Capabilities: As a bridge between the past and the present, SidecarT is ever-evolving, ensuring that enthusiasts stay at the cutting edge of emulation technology.

Objective and Purpose

The inception of SidecarT is deeply rooted in the passion and desire to develop software for obsolete machines purely for the joy and the challenge it presents. This journey, reminiscent of teenage years spent with the beloved Atari 1040STFM, was rekindled by a midlife reconnection with the old creations and the community from the Atari ST retro world.

The concept of SidecarT stemmed from the longing for the original experience of using machines from the bygone era but supercharged with the modern-day luxuries and capabilities. Itโ€™s not about just using an emulator on contemporary operating systems; itโ€™s about experiencing the speed, ease of access, and abundance of resources on the original hardware, bringing the authentic tactile experience of retro computing to the present day.

The SidecarT venture was met with several challenges, like developing a protocol to overcome the read-only constraint of the Atari STโ€™s cartridge interface and finding a suitable microcontroller that could meet the stringent response time requirements for emulating the ROMs of an Atari ST cartridge. The breakthrough came with the discovery of the Raspberry Pi Pico and its RP2040 microcontroller, which, with its Programmable Input/Output blocks, provided the precise and deterministic manner of managing I/O needed for this project.

Target Audience

SidecarT is more than just an emulator; itโ€™s a canvas for tech enthusiasts, developers, and retro computing aficionados to paint their innovations. Itโ€™s a contribution to the community, a piece of technology open for modifications, expansions, and enhancements, aiming to keep the spirit of Atari ST alive and evolving, allowing users to relive the past with a touch of the present.

Whether you are reminiscing about the golden days of computing or exploring the infinite possibilities of emulation technology, SidecarT is your conduit to a world where the past meets the future, where nostalgia intertwines with innovation. Itโ€™s not just a journey back in time; itโ€™s a journey forward in exploration and discovery.

Contribution Guidelines

Below are some quick guidelines to ensure smooth contributions to our project.

๐Ÿ“œ Licensing

๐Ÿž Reporting Bugs

  • Check for existing reports to avoid duplicates in the Issues section. Please tag as bug.
  • Provide clear details and steps to reproduce.

๐Ÿ’ก Feature Requests

  • Describe the feature and its advantages in the Issues section. Please tag as enhancement.
  • Suggest possible solutions or alternatives.

๐Ÿ’ป Code Contributions

  • Ensure adherence to GPL and current coding standards.
  • Submit through a pull request and describe the changes.

๐Ÿ›  Hardware Contributions

  • Submit designs and assembly instructions via pull request.
  • Ensure all designs are non-commercial and safe to replicate.

๐Ÿ“š Documentation

  • Focus on clarity and accuracy.
  • Follow existing documentation styles.

๐Ÿ‘€ Review Process

  • Contributions will be reviewed and feedback will be provided.
  • Once approved, your contributions will be merged.

๐Ÿ™Œ Thank You!

Thank you for your interest in contributing to SidecarTridge Multi-device! Your contributions are valuable to SidecarT. Letโ€™s build something great together!