Kick off the project with README, .gitignore, and PLAN

This commit is contained in:
2026-03-28 08:23:26 +02:00
commit 83d812e289
3 changed files with 112 additions and 0 deletions
+47
View File
@@ -0,0 +1,47 @@
# Tampiorama — Project Plan
This is a project plan for project that's meaning is to be open source showcase for Tampio, the Finnish natural-language OOP language that compiles to JavaScript.
## Project Goals
- Provide working, annotated examples of Tampio code
- Document the language for English and Finnish speakers
- Make Tampio easy to try via Docker (no manual libvoikko setup)
## Project Structure
```
tampiorama/
├── Dockerfile
├── docker-compose.yml
├── README.md ← language tour (bilingual FI/EN)
├── docs/
│ ├── cheatsheet.md ← grammatical cases → parameter roles
│ ├── install.md ← local setup without Docker
│ └── vs-javascript.md ← side-by-side comparisons
└── examples/
├── basics/ ← factorial, fibonacci, hello world
├── data-structures/ ← lists, maps
├── strings/
├── async/ ← Promise/async usage
└── program/ ← small "real" program
```
## Docker
- Base image: Debian or Ubuntu (libvoikko available via apt)
- Installs: `libvoikko-dev`, Node.js, `tampio` (npm)
- Goal: `docker run` gives a working Tampio environment with no manual setup
## Open Questions
- [ ] Docs language: bilingual FI/EN or English only? (bilingual fits the theme)
- [ ] Scope: curated examples repo, or also a GitHub Pages web showcase / playground?
- [ ] Hosting: GitHub (likely — standard for open source)
- [ ] Is Tampio working locally? The libvoikko dependency can be tricky; Docker is the primary path until confirmed.
## Notes
- Project name: **Tampiorama**
- libvoikko local setup not yet confirmed working — Docker is the primary path
- `docs/cheatsheet.md` should cover annotated grammar constructs (Finnish cases → parameter roles) as well as raw syntax