Skip to content

Commit

Permalink
readme cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
idanpa committed Dec 4, 2024
1 parent 25a8213 commit 9e090b8
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 15 deletions.
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# CalcPy
<h1 align="center">
CalcPy
</h1>

Terminal calculator and advanced math solver using Python, IPython and SymPy.
Terminal programmer calculator and advanced math solver using Python, IPython and SymPy.
The missing tweaks for using Python as a calculator.

## 🖥 Usage

## Usage
<p align="left">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/demo/demo_dark.svg">
Expand All @@ -11,17 +15,17 @@ Terminal calculator and advanced math solver using Python, IPython and SymPy.
</picture>
</p>

[Try online](https://calcpy.duckdns.org)
**[🚀 Try online](https://calcpy.duckdns.org)**

## 📦 Installation

## Installation
Prerequisites - [Python](https://www.python.org/downloads/)
```
pip install git+https://github.com/idanpa/calcpy
pip install https://github.com/idanpa/calcpy/archive/main.zip
```
(no git? use `pip install https://github.com/idanpa/calcpy/archive/main.zip`)
[Android installation](docs/android.md)

## Features
## ✨ Features

* Display both symbolic and numeric solutions
* Integers displayed as decimal, hex and binary
* Evaluation preview while typing
Expand All @@ -42,23 +46,27 @@ pip install git+https://github.com/idanpa/calcpy
* Custom user startup (for imports, etc.) `edit_user_startup()`
* Persistent configuration, see options with `calcpy?`

[SymPy](https://www.sympy.org):
#### [SymPy](https://www.sympy.org)

* All the elementary (and non-elementry) math functions and constants - `ln`, `sin`, `e`, `pi` etc.
* Calculus, algebra, plotting - `diff`, `integrate`, `limit`, `Sum`, `solve`, `plot`, `plot_implicit` etc.

[IPython](https://ipython.org):
#### [IPython](https://ipython.org)

* Get last result with `_`, get specific cell `_12` (`Out[12]` works too)
* `func_name?` show docs for func_name
* `who`/`who_ls` see all defined variables
* Prompt history with `up`/`down`, search with `ctrl+r`
* Autocomplete with `tab`
* Edit code on editor with `%edit func_name`

[Python](https://www.python.org/):
#### [Python](https://www.python.org/)

* All the basic arithmetic `+`,`-`,`*`,`/`,`**` or `^`
* Binary and hex input `0b1101`, `0xafe1`
* Scientific notation `2.12e-6`
* Programmer operations `//` integer division, `%` modulo, `&` bitwise AND, `|` bitwise OR, `^^` bitwise XOR (on calcpy `^` is exponentiation, disable with `calcpy.caret_power`), `~` bitwise not, `>>`/`<<` right/left shift.

## Contributing
## 🤝 Contributing

Feel free to open an issue for bugs/features, send a pull request or star.
2 changes: 1 addition & 1 deletion docs/android.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## CalcPy on Android (Termux)
0. Install [Termux](https://termux.com/) using [APK](https://github.com/termux/termux-app/releases) or using [F-Droid](https://f-droid.org/en/packages/com.termux/) (Play Store version is outdated)
1. On termux install requirements (some won't work on pip):
1. Install requirements:
```
pkg install build-essential libandroid-spawn libjpeg-turbo git
pkg install python python-pip python-numpy
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
author_email='[email protected]',
url='https://github.com/idanp/calcpy',
description='Terminal calculator and advanced math solver using Python, IPython and SymPy',
long_description=Path('README.md').read_text(),
long_description=Path('README.md').read_text(encoding='utf8'),
long_description_content_type='text/markdown',
packages=['calcpy','previewer'],
classifiers=[
Expand Down

0 comments on commit 9e090b8

Please sign in to comment.