spreadsheet

commit

dbe98a7f200575f2d3a76853c060f59dec211b52

parent

005b87e1c8433d5c691dec546b37c3f89532cac0

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2024-07-21 09:53

add README

Diffstat

2 files changed, 46 insertions, 0 deletions

diff --git a/README.md b/README.md

@@ -0,0 +1,46 @@
   -1     1 This is a terminal-based spreadsheet that aims to feel familiar for people
   -1     2 knowing excel.
   -1     3 
   -1     4 The data is stored in simple CSV files. Consequently, formatting (e.g.
   -1     5 left/right alignment or cell width) is not stored. The sheet can either be
   -1     6 saved in source form (including formulas) or in evaluated form. A source file
   -1     7 can also be evaluated without using the TUI by using the `--eval` command line
   -1     8 option.
   -1     9 
   -1    10 ![screenshot](screenshot.png)
   -1    11 
   -1    12 ## Key bindings
   -1    13 
   -1    14 -   Arrow keys and page up/down move the cursor
   -1    15 -   Enter will start full edit mode. `-`, `=` or a digit will start quick edit
   -1    16     mode. The difference between the two modes is the behavior of arrow keys:
   -1    17     In full edit mode, arrow keys move the text cursor. In quick edit mode,
   -1    18     arrow keys move the cell cursor (after submitting the changes).
   -1    19 -   `q` - quit
   -1    20 -   `>`/`<` - increase/decrease the width of the current column
   -1    21 -   Delete - clear the current cell
   -1    22 -   `#` - Start drag mode (blue). Move the cursor to a different cell and press
   -1    23     enter. The area between the two cells will be filled with the formula from
   -1    24     the first cell. References to rows and columns that are not prefixed with
   -1    25     `$` will be adapted.
   -1    26 -   `w` - Write the sheet to a file (source form).
   -1    27 -   `W` - Write the sheet to a file (evaluated form).
   -1    28 
   -1    29 ## Formulas
   -1    30 
   -1    31 Cells can have the following values:
   -1    32 
   -1    33 -   Integer (e.g. `1`)
   -1    34 -   Float (e.g. `1.2`)
   -1    35 -   String (e.g. `"foo"`)
   -1    36 -   Formula (e.g. `=A1 + 1`)
   -1    37 
   -1    38 Formulas can contains the following functions:
   -1    39 
   -1    40 -   `sum(A1:B2)` - calculate the sum of all fields from the given range
   -1    41 -   `bar(A1)` - draw a bar for a value between 0 and 1
   -1    42 
   -1    43 ## Prior art
   -1    44 
   -1    45 -   [sc](http://www.ibiblio.org/pub/Linux/apps/financial/spreadsheet/!INDEX.html) - spreadsheet calculator
   -1    46 -   [visidata](https://www.visidata.org/) - interactivly explore tabular data

diff --git a/screenshot.png b/screenshot.png