mirror of
https://github.com/PaddiM8/kalker.git
synced 2024-12-12 17:40:52 +01:00
Updated README files to include the new libraries and how to use kalk-component
This commit is contained in:
parent
27f314e57b
commit
537182dd01
15
README.md
15
README.md
@ -1,14 +1,14 @@
|
||||
# kalk
|
||||
[![Crates.io](https://img.shields.io/crates/v/kalk_cli)](https://crates.io/crates/kalk_cli)
|
||||
![npm](https://img.shields.io/npm/v/@paddim8/kalk)
|
||||
[![GitHub](https://img.shields.io/github/license/PaddiM8/kalk)](https://github.com/PaddiM8/kalk/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/kalk/Rust?event=push&label=build%20%26%20test)
|
||||
|
||||
|
||||
Kalk is a calculator (both program and library) that supports user-defined variables, functions, and units (experimental).
|
||||
[Project kanban board (Kolan)](https://kolan.strct.net/Board/4RAdMjLDz)
|
||||
Kalk is a calculator (both program and library) that supports user-defined variables, functions, and units (experimental, limited). It runs on Windows, macOS, Linux, and in web browsers (with WebAssembly).
|
||||
|
||||
Website: [kalk.strct.net](https://kalk.strct.net)
|
||||
[Kanban](https://kolan.strct.net/Board/4RAdMjLDz) | [Website](https://kalk.strct.net)
|
||||
|
||||
![](example.png)
|
||||
|
||||
@ -25,7 +25,14 @@ Website: [kalk.strct.net](https://kalk.strct.net)
|
||||
* Load a file including predefined functions and constants. For example, if you're going to use Kalk for physics, you load up your file with physics functions/constants when starting Kalk. `-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.
|
||||
|
||||
## Installing
|
||||
## Libraries
|
||||
|
||||
There are currently three different libraries related to kalk.
|
||||
* [kalk](https://crates.io/crates/kalk): The Rust crate that powers it all.
|
||||
* [@paddim8/kalk](https://www.npmjs.com/package/@paddim8/kalk): JavaScript bindings to `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 acts as a frontend to `@paddim8/kalk`, which lets you use kalk in the browser with a command line-like interface.
|
||||
|
||||
## Installation
|
||||
### Binaries
|
||||
Pre-compiled binaries for Linux, Windows, and macOS (64-bit) are available in the [releases page](https://github.com/PaddiM8/kalk/releases).
|
||||
### Compiling
|
||||
|
48
kalk_web/README.md
Normal file
48
kalk_web/README.md
Normal file
@ -0,0 +1,48 @@
|
||||
# Kalk Web Component
|
||||
![npm](https://img.shields.io/npm/v/@paddim8/kalk-component)
|
||||
![license](https://img.shields.io/npm/l/@paddim8/kalk-component)
|
||||
|
||||
A web component built with Svelte that uses kalk (WebAssembly).
|
||||
|
||||
![preview](preview.png)
|
||||
|
||||
## Installation & Setup
|
||||
`npm install --save @paddim8/kalk-component`
|
||||
|
||||
### Module
|
||||
```js
|
||||
import { KalkCalculator, ConsoleLine } from "@paddim8/kalk-component"
|
||||
```
|
||||
If your bundler doesn't include all the files in the output folder,
|
||||
you may need to eg. modify your build script to copy them over manually.
|
||||
I am not aware of a better way.
|
||||
|
||||
### Or only with HTML
|
||||
```html
|
||||
<script type="text/javascript" src="some/path/bundle.js"></script>
|
||||
```
|
||||
|
||||
## Usage
|
||||
```html
|
||||
<div class="kalk"> <!-- Apply css rules for position/size/font/etc. to this -->
|
||||
<kalk-calculator>
|
||||
<console-line>kalk</console-line>
|
||||
<console-line>
|
||||
<span class="hint">Type 'help' for instructions.</span>
|
||||
</console-line>
|
||||
</kalk-calculator>
|
||||
</div>
|
||||
```
|
||||
|
||||
## Customizing
|
||||
The colours in the component can be changed by using these attributes.
|
||||
```html
|
||||
<kalk-calculator
|
||||
identifierColor="cornflowerblue"
|
||||
operatorColor="darkorange"
|
||||
promptColor="mediumseagreen"
|
||||
errorColor="tomato"
|
||||
hintColor="#9c9c9c"
|
||||
linkColor="cornflowerblue"
|
||||
backgroundColor="#424242" />
|
||||
```
|
BIN
kalk_web/preview.png
Normal file
BIN
kalk_web/preview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 36 KiB |
Loading…
Reference in New Issue
Block a user