https://github.com/4silvertooth/QwikTape
Do calculations, annotate like you would on a paper "qwikly".
https://github.com/4silvertooth/QwikTape
calc calculator chevrotain quickjs sciter sciter-js tape
Last synced: 7 months ago
JSON representation
Do calculations, annotate like you would on a paper "qwikly".
- Host: GitHub
- URL: https://github.com/4silvertooth/QwikTape
- Owner: 4silvertooth
- License: mit
- Created: 2022-07-11T09:58:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T11:43:55.000Z (9 months ago)
- Last Synced: 2025-01-25T12:25:00.229Z (9 months ago)
- Topics: calc, calculator, chevrotain, quickjs, sciter, sciter-js, tape
- Language: JavaScript
- Homepage:
- Size: 524 KB
- Stars: 241
- Watchers: 4
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Do calculations, annotate it like you would on a paper "qwikly".
# Features
* Write text, calculations, and annotations with the same ease as you would on paper or in a book.
* Annotate your calculations to avoid forgetting what they were about.
* Perform calculations such as addition +, subtraction -, division ÷, multiplication ×, percentage %, and power ^.
* Create unlimited tapes using `+` button in tabs bar, switch between tapes using browser like tabs.
* View/Rename/Delete your saved tapes in the Bookmark menu, use the top left menu to view all tapes.
* Tapes will auto save, allowing you to pick up right where you left off.
* The numbers will auto format and auto indented as you type.
* Numbers are formatted according to your locale.
* You can define variables and use it in calculations.
* Hover cursor over variables to check it's value.
* Customize colors using the settings menu 
, number of decimals to display and indent length can be changed too.
* Tape calculation doesn't use operator precedence, the results will be as you would type it on a calculator.
```
100.00
+ 200.00
× 3.00
═════════════
900.00
```
* Expressions use operator precedence. `myvar = 100 + 200 × 3` myvar is `700`.
* All calculations are performed with infinite precision, resulting in highly accurate and reliable results, so [`0.1 + 0.2 = 0.3`](https://0.30000000000000004.com/)
* Export your tape as PDF 
.
EITHER
[Download QwikTape](https://github.com/4silvertooth/QwikTape/releases) from releases,
OR
```bash
git clone --recurse-submodules https://github.com/4silvertooth/QwikTape.git
```
and run
[**`run-win.bat`**](run-win.bat) for windows
[**`sh run-linux.sh`**](run-linux.sh) for linux
[**`sh run-macosx.sh`**](run-macosx.sh) for macosx
# What's in a name?
QwikTape the name is inspired by [QuickJs](https://github.com/bellard/quickjs) used by [Sciter](https://gitlab.com/sciter-engine/sciter-js-sdk), the engine which powers this application, and [Tape](https://en.wikipedia.org/wiki/Punched_tape) which is what it used to be called for such documents.
The logo is inspired by the [Rail-Road](http://htmlpreview.github.io/?https://github.com/4silvertooth/QwikTape/blob/main/build/railroad-diagram.htm) diagram the QwikTape grammar generates and a calculator.
[Chevrotain](https://github.com/Chevrotain/chevrotain) toolkit to build the parser.
Also inspired by [CalcTape](https://calctape.app/), [Numi](https://numi.app/), [Soulver](https://soulver.app/), [Calca](http://calca.io/)
# Keyboard Shortcuts
| | Windows/Linux | MacOs |
| :---: | :---: | :---: |
| New Tape | Ctrl+T | ⌘+T |
| New Tape | Ctrl+N | ⌘+N |
| Switch Tapes | Ctrl+Tab | ⌘+Tab |
| Close Tape | Ctrl+W | ⌘+W |
| Clear Tape | ESC * | ESC * |
*Select `Press ESC to clear tape content?` from settings to clear tape on pressing ESC.
# FAQ
To execute linux binary after downloading use this command.
```sh
sudo chmod +x qwiktape
```
To execute macosx binary use this command.
```sh
sudo chmod +x qwiktape
sudo xattr -d com.apple.quarantine qwiktape
```
### Relocating QwikTape to a Portable Location (e.g., a Pen Drive)
To move QwikTape to a portable location:
* Locate the `qwiktapes.db` file, typically found in the `Documents` folder of your operating system.
Move the `qwiktapes.db` file to the same directory as the QwikTape application executable.
* If QwikTape does not detect the `qwiktapes.db` file in the `Documents` folder, it will automatically search for the file in the same directory as the application executable.
# Mentions
[ilovefreesoftware](https://www.ilovefreesoftware.com/17/webware/free-virtual-notepad-for-windows-with-calculator-annotations-qwiktape.html) made a little tutorial to use QwikTape.
# Coming up.
* i18n
# Developers
QwikTape uses awesome Sciter SDK for its gui and chevrotain for the parser,
Clone the repo with submodules using,
```
git clone --recurse-submodules https://github.com/4silvertooth/QwikTape.git
```
Directory structure,
* `sdk` the sciter-js-sdk as a submodule
* `src` the source directory of the application
* `assets` icons and logos
* `components` all the reactor widgets
* `chevrotain` the parser toolkit
* `parser` the heart of it all
* `storage` the database logic
* `main.htm` the entry point
* `tests` all the tests goes in here
* `run-dev.html` for developers to debug and support in making changes.
Start developer mode by using,
[**`run-win.bat -dev`**](run-win.bat) for windows
[**`sh run-linux.sh -dev`**](run-linux.sh) for linux
[**`sh run-macosx.sh -dev`**](run-macosx.sh) for macosx
from the `prompt`, it will give you developer view of QwikTape with controls to help you make changes. It launches `scapp` from sciter-js-sdk with [run-dev.html](run-dev.html) in `--debug` mode. Use inspector to inspect.
Use,
* `Diagram` to produce rail-road diagram of the parser grammar.
* `Refresh` to refresh the application frame for any changes to css or html.
* `Tests` to bring up all the tests, run tests from the toolwindow.
* `Screen Shot` to capture the image of the main application.
* `Build` to produce final builds.
* `Inspector` to open inspector for debugging
* `Help` to open sciter sdk documentation
I've build all assets like icons and logos inside [`src/assets`](src/assets) in figma and are licensed under [CC](
https://creativecommons.org/licenses/by/4.0/).