termicalc
v0.0.4
Published
A simple calculator that runs in the terminal
Maintainers
Readme
Termicalc
A lightweight, powerful terminal-based calculator with real-time evaluation capabilities.
🚀 Features
- ✨ Real-time calculation as you type
- 🔢 Basic arithmetic operations (+, -, *, /, ^)
- 📊 Parentheses support for operation precedence
- 🔍 Decimal number precision
- 💻 Clean and minimal CLI interface
- 🖱️ Access via
tcortermicalccommands
📦 Installation
Install globally via npm:
npm install -g termicalc🎯 Quick Start
After installation, you can start the calculator by typing:
termicalc
# or use the shorthand
tc📖 Usage
Basic Operations
> 2 + 2
= 4
> (3 + 2) * 4
= 20
> 2.5 * 3
= 7.5Keyboard Controls
| Key | Action |
|-----------|-----------------------|
| q | Quit application |
| Ctrl+C | Exit calculator |
| Enter | Evaluate expression |
🛠️ Development
Prerequisites
- Node.js (>= 18.x)
- npm (>= 9.x)
Local Setup
Clone the repository:
git clone https://github.com/Essien-Emmanuel/Termicalc.git cd TermicalcInstall dependencies:
npm install
Scripts
Start the calculator in development mode:
npm run calcBuild the project:
npm run buildRun tests:
npm test
🤝 Contributing
Contributions are welcome! Please follow these steps:
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
See CONTRIBUTING.md for more details.
📄 License
This project is licensed under the ISC License - see the LICENSE file for details.
👤 Author
Emmanuel Essien
- GitHub: @Essien-Emmanuel
- npm: termicalc
🌟 Show your support
Give a ⭐️ if this project helped you!
📝 Changelog
See CHANGELOG.md for release history.
This README was generated with ❤️
