Skip to content

Commit a3b85fc

Browse files
Update the README.md file
1 parent 2560b00 commit a3b85fc

1 file changed

Lines changed: 23 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,24 @@
44
[![doc:link](https://img.shields.io/badge/doc%3Alink-link-blue?logo=github)](https://thewizardplusplus.github.io/luaplot/)
55
[![lint](https://github.com/thewizardplusplus/luaplot/actions/workflows/lint.yaml/badge.svg)](https://github.com/thewizardplusplus/luaplot/actions/workflows/lint.yaml)
66
[![test](https://github.com/thewizardplusplus/luaplot/actions/workflows/test.yaml/badge.svg)](https://github.com/thewizardplusplus/luaplot/actions/workflows/test.yaml)
7+
[![luarocks](https://img.shields.io/badge/luarocks-link-blue?logo=lua)](https://luarocks.org/modules/thewizardplusplus/luaplot)
78

89
The library that implements a model of a 2D plot with support for displaying functions of time (as in an oscilloscope).
910

11+
_**Disclaimer:** this library was written directly on an Android smartphone with the [QLua](https://play.google.com/store/apps/details?id=com.quseit.qlua5pro2) IDE._
12+
1013
## Features
1114

1215
- models:
1316
- 2D plot:
1417
- storing:
1518
- values of a displayed function;
16-
- limits for these values;
19+
- a `Range` from the [luamath](https://github.com/thewizardplusplus/luamath) library with limits for these values;
1720
- default value;
1821
- operations:
1922
- initializing:
2023
- filling a specified count of values by a specified default value;
21-
- iterating over values:
24+
- iterating over points represented as `Vector2D(index, value)` from the [luamath](https://github.com/thewizardplusplus/luamath) library:
2225
- via the `__ipairs` metamethod (for Lua 5.2);
2326
- via the `__index` metamethod (for Lua 5.3+):
2427
- support of fractional indexes;
@@ -32,6 +35,10 @@ The library that implements a model of a 2D plot with support for displaying fun
3235
- removing the first value:
3336
- returning the removed value:
3437
- returning a specified default value if no values;
38+
- serialization via the [luaserialization](https://github.com/thewizardplusplus/luaserialization) library:
39+
- exposing a class name and a stringified representation;
40+
- generating a JSON Schema via the `schema()` static method;
41+
- constructing an instance from serializable options via the `from_options()` static method;
3542
- 2D oscillogram:
3643
- extending the 2D plot model;
3744
- kinds:
@@ -42,37 +49,36 @@ The library that implements a model of a 2D plot with support for displaying fun
4249
- updating:
4350
- first step: adding a new value;
4451
- second step: removing the first value;
52+
- serialization via the [luaserialization](https://github.com/thewizardplusplus/luaserialization) library:
53+
- exposing a class name and a stringified representation;
54+
- generating a JSON Schema via the `schema()` static method;
55+
- constructing an instance from serializable options via the `from_options()` static method;
4556
- 2D plot/oscillogram iterator:
4657
- storing:
4758
- 2D plot/oscillogram;
48-
- transformer for iterated values;
49-
- iterating over values of 2D plot/oscillogram:
59+
- transformer for iterated points;
60+
- iterating over transformed points of 2D plot/oscillogram:
5061
- via the `__ipairs` metamethod (for Lua 5.2);
5162
- via the `__index` metamethod (for Lua 5.3+);
52-
- applying transformations to iterated values via a specified transformer;
63+
- applying transformations to iterated points via a specified transformer;
5364
- factory of a 2D plot/oscillogram iterator:
5465
- storing:
55-
- transformer for iterated values;
66+
- transformer for iterated points;
5667
- generating a 2D plot/oscillogram iterator for a specific 2D plot/oscillogram;
5768
- global operations:
5869
- calculating a difference (a distance) between two 2D plots/oscillograms in the same index:
5970
- returning a difference (a distance) by modulo (optionally);
6071
- selecting a value by a distance between two 2D plots/oscillograms in the specific index:
61-
- selecting by the specified sequential distance ranges.
72+
- selecting by the specified sequential distance ranges;
73+
- serialization of distance ranges via the [luaserialization](https://github.com/thewizardplusplus/luaserialization) library:
74+
- exposing a class name and a stringified representation;
75+
- generating a JSON Schema via the `schema()` static method;
76+
- constructing an instance from serializable options via the `from_options()` static method.
6277

6378
## Installation
6479

65-
Clone this repository:
66-
67-
```
68-
$ git clone https://github.com/thewizardplusplus/luaplot.git
69-
$ cd luaplot
70-
```
71-
72-
Install the library with the [LuaRocks](https://luarocks.org/) tool:
73-
7480
```
75-
$ luarocks make
81+
$ luarocks install luaplot
7682
```
7783

7884
## Examples

0 commit comments

Comments
 (0)