UPDATE: text changes in some sections, adds placeholder pages

This commit is contained in:
Daniel
2024-11-24 19:14:18 +01:00
committed by Nicolás Hatcher Andrés
parent 16212b1518
commit cb38eff899
8 changed files with 98 additions and 48 deletions

View File

@@ -9,3 +9,14 @@ lang: en-US
::: warning
**Note:** This page is in construction 🚧
:::
# About TironCalc
**TironCalc**, or **Tiron** for friends, is a TUI (Terminal User Interface) for **IronCalc**. Its designed to bring the functionality of IronCalc to the command line, using the [**ratatui**](https://github.com/ratatui-org/ratatui) library.
## Inspiration
TironCalc is inspired by earlier terminal-based spreadsheet tools:
- James Gosling of Java fame created [sc](<https://en.wikipedia.org/wiki/Sc_(spreadsheet_calculator)>) the spreadsheet calculator.
- Andrés Martinelli has been maintaining [sc-im](https://github.com/andmarti1424/sc-im), the spreadsheet calculator improvised.

View File

@@ -6,6 +6,32 @@ lang: en-US
# Installing and running Tironcalc
::: warning
**Note:** This page is in construction 🚧
:::
## Build
```
cargo build --release
```
You will find the binary at `./target/release/tiron`.
## Documentation
Start empty project:
```
$ tiron
```
Load an existing Excel file:
```
$ tiron example.xlsx
```
- `Arrow Keys` to navigate cells
- `e` to edit a cell and enter the value or formula.
- `q` to quit and save
- `+` to add a sheet
- `s` to go to the next sheet
- `a` to go to the previous sheet
- `PgUp/PgDown` to navigate rows faster