mirror of
https://github.com/PaddiM8/kalker.git
synced 2025-01-23 05:28:34 +01:00
Made README headers bigger
This commit is contained in:
parent
bbfd3fde3e
commit
bb626a390f
36
README.md
36
README.md
@ -4,11 +4,11 @@ Kalker (or "kalk") is a calculator program/website that supports user-defined va
|
|||||||
|
|
||||||
[![Crates.io](https://img.shields.io/crates/v/kalker)](https://crates.io/crates/kalker) ![npm](https://img.shields.io/npm/v/@paddim8/kalk) [![GitHub](https://img.shields.io/github/license/PaddiM8/kalk)](https://github.com/PaddiM8/kalker/blob/master/LICENSE) [![Docs.rs](https://docs.rs/kalk/badge.svg)](https://docs.rs/kalk/latest/kalk/) ![Build status](https://img.shields.io/github/workflow/status/PaddiM8/kalker/Rust?event=push&label=build%20%26%20test)
|
[![Crates.io](https://img.shields.io/crates/v/kalker)](https://crates.io/crates/kalker) ![npm](https://img.shields.io/npm/v/@paddim8/kalk) [![GitHub](https://img.shields.io/github/license/PaddiM8/kalk)](https://github.com/PaddiM8/kalker/blob/master/LICENSE) [![Docs.rs](https://docs.rs/kalk/badge.svg)](https://docs.rs/kalk/latest/kalk/) ![Build status](https://img.shields.io/github/workflow/status/PaddiM8/kalker/Rust?event=push&label=build%20%26%20test)
|
||||||
|
|
||||||
[Kanban](https://kolan.strct.net/Board/4RAdMjLDz) | [Website - Try it out here!](https://kalker.strct.net)
|
[Kanban](https://kolan.strct.net/Board/4RAdMjLDz) | [Website - Try it out here!](https://kalker.strct.net) | [Donate](#ditsonation)
|
||||||
|
|
||||||
![](preview.png)
|
![](preview.png)
|
||||||
|
|
||||||
## Features
|
# Features
|
||||||
|
|
||||||
* Operators: `+`, `-`, `*`, `/`, `!`
|
* Operators: `+`, `-`, `*`, `/`, `!`
|
||||||
* Groups: `()`, `⌈ceil⌉`, `⌊floor⌋`, `[iverson]`
|
* Groups: `()`, `⌈ceil⌉`, `⌊floor⌋`, `[iverson]`
|
||||||
@ -24,39 +24,43 @@ Kalker (or "kalk") is a calculator program/website that supports user-defined va
|
|||||||
* Load a file including predefined functions and constants. For example, if you're going to use kalker for physics, you load up your file with physics functions/constants when starting kalker. `-i file`
|
* Load a file including predefined functions and constants. For example, if you're going to use kalker for physics, you load up your file with physics functions/constants when starting kalker. `-i file`
|
||||||
* Misc: separate expressions by a semicolon to write them on the same line, use the `ans` variable to get the value of the previously calculated expression.
|
* Misc: separate expressions by a semicolon to write them on the same line, use the `ans` variable to get the value of the previously calculated expression.
|
||||||
|
|
||||||
## Installation
|
# Installation
|
||||||
|
|
||||||
### Package managers
|
## Package managers
|
||||||
|
|
||||||
#### macOS
|
### macOS
|
||||||
`brew install kalker`
|
`brew install kalker`
|
||||||
|
|
||||||
#### Arch Linux
|
### Arch Linux
|
||||||
`kalker` in the AUR, eg. `yay -S kalker`
|
`kalker` in the AUR, eg. `yay -S kalker`
|
||||||
|
|
||||||
#### Nix/NixOS
|
### Nix/NixOS
|
||||||
Kalker is available through [`nixpkgs`](https://search.nixos.org/packages?channel=unstable&show=kalker&from=0&size=50&sort=relevance&type=packages&query=kalker).
|
Kalker is available through [`nixpkgs`](https://search.nixos.org/packages?channel=unstable&show=kalker&from=0&size=50&sort=relevance&type=packages&query=kalker).
|
||||||
The most up to date version is also available as a [`flake`](https://search.nixos.org/flakes?channel=unstable&show=kalker&from=0&size=50&sort=relevance&type=packages&query=kalker).
|
The most up to date version is also available as a [`flake`](https://search.nixos.org/flakes?channel=unstable&show=kalker&from=0&size=50&sort=relevance&type=packages&query=kalker).
|
||||||
|
|
||||||
### Binaries
|
## Binaries
|
||||||
|
|
||||||
Pre-compiled binaries for Linux, Windows, and macOS (64-bit) are available in the [releases page](https://github.com/PaddiM8/kalker/releases).
|
Pre-compiled binaries for Linux, Windows, and macOS (64-bit) are available in the [releases page](https://github.com/PaddiM8/kalker/releases).
|
||||||
|
|
||||||
### Compiling
|
## Compiling
|
||||||
|
|
||||||
**Minimum rust version: v1.36.0**. Make sure you have `diffutils` `gcc` `make` and `m4` installed. **If you use windows:** [follow the instructions here](https://docs.rs/gmp-mpfr-sys/1.2.3/gmp_mpfr_sys/index.html#building-on-windows) (don't forget to install `mingw-w64-x86_64-rust` in MSYS2).
|
**Minimum rust version: v1.36.0**. Make sure you have `diffutils` `gcc` `make` and `m4` installed. **If you use windows:** [follow the instructions here](https://docs.rs/gmp-mpfr-sys/1.2.3/gmp_mpfr_sys/index.html#building-on-windows) (don't forget to install `mingw-w64-x86_64-rust` in MSYS2).
|
||||||
|
|
||||||
#### Cargo
|
### Cargo
|
||||||
|
|
||||||
Run `cargo install kalker`
|
Run `cargo install kalker`
|
||||||
|
|
||||||
#### Manually
|
### Manually
|
||||||
|
|
||||||
1. Go into the `cli` directory.
|
1. Go into the `cli` directory.
|
||||||
2. Run `cargo build --release`
|
2. Run `cargo build --release`
|
||||||
3. Grab the binary from `targets/release`
|
3. Grab the binary from `targets/release`
|
||||||
|
|
||||||
## Libraries
|
# Donation
|
||||||
|
|
||||||
|
Kalker is completely free and open source. If you wish to support further development of Kalker, you can do so here: [PayPal](https://paypal.me/oliverwaldemar)
|
||||||
|
|
||||||
|
# Libraries
|
||||||
|
|
||||||
There are currently three different libraries related to kalker.
|
There are currently three different libraries related to kalker.
|
||||||
|
|
||||||
@ -64,11 +68,11 @@ There are currently three different libraries related to kalker.
|
|||||||
* [@paddim8/kalk](https://www.npmjs.com/package/@paddim8/kalk): JavaScript bindings for `kalk`. This lets you use it in the browser thanks to WebAssembly.
|
* [@paddim8/kalk](https://www.npmjs.com/package/@paddim8/kalk): JavaScript bindings for `kalk`. This lets you use it in the browser thanks to WebAssembly.
|
||||||
* [@paddim8/kalk-component](https://www.npmjs.com/package/@paddim8/kalk-component): A web component that runs `@paddim8/kalk`, which let's you use kalk in the browser with a command line-like interface.
|
* [@paddim8/kalk-component](https://www.npmjs.com/package/@paddim8/kalk-component): A web component that runs `@paddim8/kalk`, which let's you use kalk in the browser with a command line-like interface.
|
||||||
|
|
||||||
## Syntax
|
# Syntax
|
||||||
|
|
||||||
A more complete reference can be found on [the website](https://kalker.strct.net)
|
A more complete reference can be found on [the website](https://kalker.strct.net)
|
||||||
|
|
||||||
### Functions
|
## Functions
|
||||||
|
|
||||||
**Defining:** name(parameter1, parameter2, ...) = expression\
|
**Defining:** name(parameter1, parameter2, ...) = expression\
|
||||||
**Example:** `f(x) = 2x+3`
|
**Example:** `f(x) = 2x+3`
|
||||||
@ -76,7 +80,7 @@ A more complete reference can be found on [the website](https://kalker.strct.net
|
|||||||
**Using:** name(argument1, argument2)\
|
**Using:** name(argument1, argument2)\
|
||||||
**Example:** `f(2)`
|
**Example:** `f(2)`
|
||||||
|
|
||||||
### Variables
|
## Variables
|
||||||
|
|
||||||
**Defining:** name = expression\
|
**Defining:** name = expression\
|
||||||
**Example:** `x = 3`
|
**Example:** `x = 3`
|
||||||
@ -84,7 +88,7 @@ A more complete reference can be found on [the website](https://kalker.strct.net
|
|||||||
**Using:** name\
|
**Using:** name\
|
||||||
**Example:** `x`
|
**Example:** `x`
|
||||||
|
|
||||||
## Contributing
|
# Contributing
|
||||||
|
|
||||||
## kalk and cli (Rust)
|
## kalk and cli (Rust)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user