Fast-Typy 0.1.0

A command line typing game

<img src="images/logo.png" alt="Logo" width="80" height="80">

Fast-Typy

A command line game for simple, fast, and easy to use typing game.

<br />

<a href="https://github.com/PrynsTag/Fast-Typy"><strong>Explore the docs »</strong></a>

<br />

<br />

<a href="https://github.com/PrynsTag/Fast-Typy">View Demo</a>

·

<a href="https://github.com/PrynsTag/Fast-Typy/issues">Report Bug</a>

·

<a href="https://github.com/PrynsTag/Fast-Typy/issues">Request Feature</a>

Table of Contents

<li>

  <a href="#about-the-project">About The Project</a>

  <ul>

    <li><a href="#built-with">Built With</a></li>

  </ul>

</li>

<li>

  <a href="#getting-started">Getting Started</a>

  <ul>

    <li><a href="#prerequisites">Prerequisites</a></li>

    <li><a href="#installation">Installation</a></li>

  </ul>

</li>

<li><a href="#usage">Usage</a></li>

<li><a href="#roadmap">Roadmap</a></li>

<li><a href="#contributing">Contributing</a></li>

<li><a href="#license">License</a></li>

<li><a href="#contact">Contact</a></li>

<li><a href="#acknowledgments">Acknowledgments</a></li>

About The Project

(back to top)

Built With

• Python

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally.

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo or install the package from PyPI

   git clone https://github.com/PrynsTag/Fast-Typy.git
   

   OR

   pip install fast-typy
   

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Replace txt files with a database

• Add API

• Create a web or desktop app

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

(back to top)

Contact

Prince Carl Velasco - @PrynsTag - [e-mail]

Project Link: https://github.com/PrynsTag/Fast-Typy

(back to top)

Acknowledgments

• Python

• Best-README-Template

• shields.io

(back to top)