diff --git a/README.md b/README.md index 6642e23..a33edd4 100644 --- a/README.md +++ b/README.md @@ -1 +1,74 @@ # CHIP8 Emulator in Modern C++ + +A CHIP8 emulator written in modern C++. Tested using test ROM from [corax89/chip8-test-rom](https://github.com/corax89/chip8-test-rom). + +[![issues](https://img.shields.io/github/issues/SmartPolarBear/cchip8)](https://github.com/SmartPolarBear/cchip8/issues) +[![forks](https://img.shields.io/github/forks/SmartPolarBear/cchip8)](https://github.com/SmartPolarBear/cchip8/fork) +[![stars](https://img.shields.io/github/stars/SmartPolarBear/cchip8)](https://github.com/SmartPolarBear/cchip8/stargazers) +[![license](https://img.shields.io/github/license/SmartPolarBear/cchip8)](https://github.com/SmartPolarBear/cchip8/blob/master/LICENSE) +[![twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2F___zirconium___)](https://twitter.com/___zirconium___) + +### Built With + +#### Environment + +This project is built with + +- Clang on Windows 13.0 with MSVC. +- CMake, 3.21 and above. + + +#### Third-party Libraries +- [microsoft/GSL](https://github.com/microsoft/GSL) +- [p-ranav/argparse](https://github.com/p-ranav/argparse) +- [Neargye/magic_enum](https://github.com/Neargye/magic_enum) + +### Usage + +To see usage, run +```shell +cchip8 --help +``` + +## Contributing + +Contributions are what make the open source community such an amazing place to be learned, inspire, and create_on_heap. Any contributions you make are **greatly appreciated**. + +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 + +Furthermore, you are welcomed to: + +1. [Ask a question](https://github.com/SmartPolarBear/cchip8/discussions/categories/q-a) + Also, have a look at our [FAQs](). +2. [Start a discussion](https://github.com/SmartPolarBear/cchip8/discussions/categories/general) + Discussions can be about any topics or ideas related to CLOX. +3. [Make a feature proposal](https://github.com/SmartPolarBear/cchip8/issues) + Language features do you want to appear or not to appear in CLOX? For example, you can propose a new grammar making the lox better, or an idea for library features. + +## License + +Copyright (c) 2021 SmartPolarBear + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +