Kick off the project with README, .gitignore, and PLAN
This commit is contained in:
@@ -0,0 +1,47 @@
|
||||
# Tampiorama
|
||||
|
||||
A showcase for [Tampio](https://github.com/fergusq/tampio), a natural-language object-oriented programming language that uses Finnish grammar and compiles to JavaScript.
|
||||
|
||||
Tampiorama provides working, annotated examples and documentation to help you explore Tampio without wrestling with its native dependencies.
|
||||
|
||||
## Quickstart (Docker)
|
||||
|
||||
The easiest way to try Tampio, no manual `libvoikko` setup required:
|
||||
|
||||
```sh
|
||||
docker compose run --rm tampio
|
||||
```
|
||||
|
||||
This drops you into a shell with `tampio` available. Run any example:
|
||||
|
||||
```sh
|
||||
tampio examples/basics/hello.tampio
|
||||
```
|
||||
|
||||
## What is Tampio?
|
||||
|
||||
Tampio programs read like Finnish sentences. Methods are defined using grammatical cases, so the language's syntax is shaped by natural-language morphology rather than punctuation.
|
||||
|
||||
```tampio
|
||||
[Tampio example will go here]
|
||||
```
|
||||
|
||||
See [`docs/cheatsheet.md`](docs/cheatsheet.md) for a map of Finnish grammatical cases to their roles in Tampio code, and [`docs/vs-javascript.md`](docs/vs-javascript.md) for side-by-side comparisons with JavaScript.
|
||||
|
||||
## Examples
|
||||
|
||||
| Directory | Contents |
|
||||
|-----------|----------|
|
||||
| `examples/basics/` | Hello world, factorial, Fibonacci |
|
||||
| `examples/data-structures/` | Lists, maps |
|
||||
| `examples/strings/` | String manipulation |
|
||||
| `examples/async/` | Promise / async usage |
|
||||
| `examples/program/` | A small complete program |
|
||||
|
||||
## Local Setup (without Docker)
|
||||
|
||||
See [`docs/install.md`](docs/install.md) for instructions on installing `libvoikko` and `tampio` natively.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user