TibixDev/Chirp

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 The Project

(back to top)

Built With

• Vanilla JS
• Webpack
• Simple.css

(back to top)

Getting Started

Chirp doesn't use any frameworks, you will just need to compile the project with Webpack and use the generated directory structure from dist.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• node.js (LTS recommended)
• npm

  npm install npm@latest -g
  

Installation

1. Clone the repo

   git clone https://github.com/TibixDev/Chirp.git
   

2. Install NPM packages

   yarn install
   

3. Build the project

   npx webpack --mode=production 
   

4. Deploy the dist folder or view it using live-server
5. Enjoy!

(back to top)

Roadmap

• Fixing errors that cause inaccurate emulation
• Peer-to-peer multiplayer (planned, not confirmed)
• Embedded debugging info & tools

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 for more information.

(back to top)

Contact

• Mail: [email protected]
• Discord: Tibix#5166

Project Link: https://github.com/TibixDev/Chirp

(back to top)

Acknowledgments

• Emulation Development Discord for inspiring me to make this project and explaining concepts
• Tobias V. Langhoff for writing a CHIP-8 emulator guide
• Levev for helping me with explanations and debugging

(back to top)