Skip to content

README.md

Latest commit

 

History

History
78 lines (54 loc) · 2.81 KB

README.md

File metadata and controls

78 lines (54 loc) · 2.81 KB
Raw

orCAL

orCAL is a Rust calculator with a Tauri interface. The web UI is served by Tauri and calls the Rust calculation engine. It is software from the Colony project (https://github.com/Project-Colony/Colony).

Features

  • Operations: addition, subtraction, multiplication, division and decimal numbers
  • Scientific keypad (tablet layout): parentheses, powers (^, right-associative), factorials (!, whole numbers from 0 to 170), sin, cos and tan in degrees, ln, log (base 10), square root, the constants π and e, and ANS for the previous result
  • Implicit multiplication: 2π, 2(3) and (2)(3) multiply
  • Error handling: incomplete expression, invalid token, division by zero, undefined or infinite result, factorial out of range, and expressions nested more than 256 levels deep

Every expression, from either layout, is evaluated by the Rust engine in crates/orcal-core. The interface never evaluates code itself, and the web view runs under a content security policy that only allows the app's own scripts, styles and IPC.

Prerequisites

  • Rust (stable toolchain) and Cargo installed
  • System dependencies for Tauri (see the Tauri documentation for your OS)

Installation

cargo build -p orcal-tauri

Usage

To start the Tauri app in development mode:

cargo run -p orcal-tauri

Development

  • cargo run -p orcal-tauri to run the Tauri app
  • cargo build -p orcal-tauri --release to compile in release mode

Structure

  • crates/orcal-core: parsing and evaluation logic
  • src-tauri: Tauri application
  • ui/: HTML/CSS/JS interface

Code signing policy

Free code signing provided by SignPath.io, certificate by SignPath Foundation.

Windows builds are signed this way once the SignPath Foundation has accepted the project; until then they ship without Authenticode. Every release asset, on every platform, is always signed with the Project-Colony organisation's ed25519 key, which Colony verifies before installing it.

Privacy policy

This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.

orCAL contains no network code and no telemetry. Its interface is rendered by the operating system's web view (Microsoft Edge WebView2 on Windows, WebKit on macOS and Linux), which follows its vendor's own privacy policy.

License

GPL-3.0-or-later. You may redistribute and modify orCAL under the terms of version 3 of the GNU General Public License, or (at your option) any later version. The full text is in LICENSE.