Skip to content

README.md

Latest commit

 

History

History
129 lines (96 loc) · 5.19 KB

README.md

File metadata and controls

129 lines (96 loc) · 5.19 KB

Calculator Application:

This calculator application is a user-friendly tool designed to perform basic arithmetic
operations quickly and efficiently. Whether you need to add, subtract, multiply, divide,
or calculate percentages, this calculator provides a straightforward interface for all 
your mathematical needs. With support for both keyboard and button input, it's easy to 
use on desktop devices.

Version: Calculator 1.0

Table of Contents:

- [Overview]
- [Features]
- [Installation]
- [Getting Started]
- [Usage]
- [License]
- [Copyright Information]
- [Author]
- [Support]

Overview:

The Calculator Application offers two types of calculators: Standard and Scientific. The
Standard calculator is fully functional and ready to use, while the Scientific calculator
is currently under development.

Features:

### Standard Calculator:
	- Simple and intuitive user interface.
	- Supports basic arithmetic operations: addition, subtraction, multiplication, division,
	  and percentage calculations.

### Scientific Calculator (Under Development):
	- Advanced scientific functions such as trigonometric, logarithmic, and exponential functions.
	- Additional features to be added in future updates.

Installation:

### Windows:
	1. Download the latest release of the Calculator Application from the [Releases] page.
	2. Extract the downloaded ZIP file to a location on your computer.
	3. Double-click on the `calculator_setup.exe` file to launch the application.

### Unix-based Systems (Linux, macOS):
	1. Download the latest release of the Calculator Application from the [Releases] page.
	2. Extract the downloaded ZIP file to a location on your computer.
	3. Run the executable file to launch the application.

Getting Started:

Once the application is installed, launch it by running the executable file. Follow the
instructions provided in the Usage section to perform arithmetic operations using the
Standard calculator.

Usage:

### Instructions for Performing Various Calculation Operations:

	1. Performing Arithmetic Operations: To perform any arithmetic operation, enter the
	   first number followed by the desired arithmetic operator button (+, -, *, /), then
 	   enter the second value, then press the equals (=) button.

	2. Performing Series of Arithmetic Operations: To perform a series of arithmetic
 	   operations (e.g., 895 + 94.5 - 45 / 2 * 3 + 10%), simply enter the operations in the
  	   order specified in the expression.

	3. Calculating Percentage: To calculate a percentage, enter the number followed by the
	   % button (e.g., 1250%). This will calculate 1% of the entered value.

	4. Calculating Specific Percentage: To calculate a specified percentage of any value,
	   enter the number followed by the * (asterisk) button and then the desired percentage
  	   value followed by the % button (e.g., 1250 * 10% = 125).

	5. Adding Calculated Percentage to Original Value: To add the calculated percentage
	   value to the original value, perform the operation like this: `1250 + 10% = 1375`.
  	   Similar operations are allowed with other operators along with the percentage symbol
   	   (e.g., `1250 / 10%`, `1250 - 10%`).

	6. Handling Division by Zero: In case of division by zero, a "Division by Zero Error"
	   will be raised in the display and operator buttons (+, -, *, /, %) will be disabled.
  	   To reset the calculator, press any enabled key like C, CE, Back, or 0-9 keys.

	7. Negating a Value: To negate the value, simply enter the value followed by the +/-
	   button.
	
	8. Resetting the Calculator: To reset the calculator, press the C (Clear) button.

	9. Clearing the Current Entry: To clear the current entry, press the CE (Clear Entry)
	   button.
	
	10.Removing the Last Digit of the Current Value: To remove the last digit of the current
	   value, simply press the Back key.

### Keyboard Shortcut Table:
    |--------------|-------------------------|
    | Shortcut Key | Function                |
    |--------------|-------------------------|
    | Esc          | Reset the calculator    |
    | Delete       | Clear the current entry |
    | Backspace    | Remove the last digit   |
    | 0-9          | Enter numbers           |
    | .            | Decimal Point           |
    | +            | Addition                |
    | -            | Subtraction             |
    | *            | Multiplication          |
    | /            | Division                |
    | %            | Percentage              |
    | = | Enter    | Equal to                |
    | F9           | Negate the value        |
    |--------------|-------------------------|

License:

This software is provided free of charge for personal and non-commercial use. See the LICENSE
file for more information.

Copyright Information

This project is copyright (C) 2024 Ashish Kumar (ashish.bmistry@gmail.com).

Author:

Ashish Kumar (ashish.bmistry@gmail.com).

Support:

For any questions, issues, or feature requests regarding the Calculator Application, please 
contact ashish.bmistry@gmail.com.