README

Tablas de Multiplicar - Mental Calculation Trainer

A program to help you with mental calculations

This project is an application to help everyone practice mental calculations. It features modes to train and play as well as different features. Plus, it is totally free and open-source.

Note that there's a version of this README (Instructions) file in each of the languages in which the game is available. Please, refer to you prefered language here. *

• English
• Español
• Català
• Deutsch
• Français
• Italian
• Português
• 中文
• 日语
• 한국어
• عربي
• русский
• हिन्दी
• বাংলা
• Türkçe
• Tiếng Việt
• ไทย
• فارسی
• Melayu
• Filipino
• Kiswahili
• Polski
• Українська

Table of Contents

• Project Overview
• Features
• Installation
• Usage
• Contributing
• License

Project Overview

This is the 4th version of the program and the first in which we have implemented JavaScript and webview. The previous versions were based on Python and required to be run on the terminal. With this new version, we have enhanced the user interface as well as added some features. Our goal is to help everyone improve their mental calculation skills. We have included a mode to train and a mode to play. The training mode will help you practice in a way tailored to your needs. Whereas the play mode will challenge you with different operations at one time.

Features

• Training Mode: A mode to practice mental calculations in a way tailored to your needs.
• Gaming Mode: A mode to challenge you with different operations at one time.
• User Interface: An enhanced user interface to make the application more accessible and user-friendly compared to previous versions.
• JavaScript and Webview: The application is built using JavaScript and webview, allowing for a more modern and interactive experience.
• Free and Open-Source: The application is completely free and open-source, allowing anyone to contribute and modify the code.
• Multi-Operation Support: The application supports multiple operations, including addition, subtraction, multiplication, and division.

Installation

1. Step 1: Clone the repository from GitHub using the button
2. Step 2: Unzip folder and access the v4 folder inside it
3. Step 3: Open the index.html on your browser (by double clicking it)
4. Step 4: You can consider adding a link to this file elsewhere in your computer to make it more accessible from there.

Usage

Getting Started

1. Step 1: Run the project
2. Step 2: Follow the prompts

Contributing

Guidelines

This is an open-source project and we encourage you to contribute to it. Please, follow the guidelines below and don't forget to adhere to our Code of Conduct

Step 1: Fork the Repository

Fork the repository by clicking the "Fork" button in the top-right corner of the repository page. This will create a copy of the repository in your own GitHub account.

Step 2: Clone the Repository

Clone the repository to your local machine using the command:

git clone https://github.com/your-username/tdm.git

Step 3: Create a New Branch

Create a new branch to work on your contribution using the command:

git checkout -b your-branch-name

Step 4: Make Changes

Make the necessary changes to the code or documentation. Make sure to follow the project's coding standards and guidelines.

Step 5: Commit Changes

Commit your changes using the command:

git add .
git commit -m "Your commit message"

Step 6: Push Changes

Push your changes to your forked repository using the command:

git push origin your-branch-name

Step 7: Create a Pull Request

Create a pull request to merge your changes into the main repository. To do this, go to the repository page and click the "New pull request" button. Select the branch you want to merge into and fill in the pull request description.

Step 8: Review and Merge

The project maintainers will review your pull request and merge it into the main repository if it is considered adequate.

Guidelines for Contributions

• Make sure to follow the project's coding standards and guidelines.
• Keep your contributions concise and focused on a single issue or feature.
• Use clear and descriptive commit messages.
• Use clear and descriptive pull request titles and descriptions.
• Make sure to test your changes before submitting a pull request.

Reporting Issues

If you find an issue with the project, please report it using the issue tracker. To report an issue, follow these steps:

1. Go to the Issue Tracker page.
2. Click on the "New issue" button.
3. Fill in the title and description of the issue. Be as detailed as possible.
4. Choose the relevant labels for the issue (e.g. bug, feature, enhancement).
5. Assign the issue to the relevant person or team, if applicable.
6. Click on the "Submit new issue" button.

Note: Before reporting an issue, make sure to check if a similar issue already exists in the repository.

Reporting Issues

Adding new GitHub Issues

To add a new issue to the repository, follow these steps:

1. Go to the Issue Tracker page.
2. Click on the "New issue" button.
3. Fill in the title and description of the issue. Be as detailed as possible.
4. Choose the relevant labels for the issue (e.g. bug, feature, enhancement).
5. Assign the issue to the relevant person or team, if applicable.
6. Click on the "Submit new issue" button.

Note: Before adding a new issue, make sure to check if a similar issue already exists in the repository.

License

This project is licensed under the MIT License.

* Note that all translations for languages other than English, Spanish, Catalan, and German where generated automatically and may have errors. The owner does not guarantee the accuracy of the translations and has any responsibity for them.