{"id":15099823,"url":"https://github.com/sea-grass/zig-present","last_synced_at":"2026-01-06T22:44:27.881Z","repository":{"id":252569665,"uuid":"840445184","full_name":"sea-grass/zig-present","owner":"sea-grass","description":"A command-line tool for running interactive TUI presentations.","archived":false,"fork":false,"pushed_at":"2024-08-10T19:24:45.000Z","size":115,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T18:15:02.304Z","etag":null,"topics":["presentation","tui","zig","zig-package"],"latest_commit_sha":null,"homepage":"","language":"Zig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sea-grass.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-09T18:11:40.000Z","updated_at":"2024-11-05T14:08:48.000Z","dependencies_parsed_at":"2024-08-10T21:09:27.203Z","dependency_job_id":null,"html_url":"https://github.com/sea-grass/zig-present","commit_stats":null,"previous_names":["sea-grass/zig-present"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sea-grass%2Fzig-present","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sea-grass%2Fzig-present/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sea-grass%2Fzig-present/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sea-grass%2Fzig-present/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sea-grass","download_url":"https://codeload.github.com/sea-grass/zig-present/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245858876,"owners_count":20684057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["presentation","tui","zig","zig-package"],"created_at":"2024-09-25T17:27:55.247Z","updated_at":"2026-01-06T22:44:27.839Z","avatar_url":"https://github.com/sea-grass.png","language":"Zig","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zig-present\n\n`zig-present` is a command-line tool for creating interactive TUI presentations.\n\n\u003cdiv style=\"max-width: 100%; margin: 0 auto; width: 800px;\"\u003e\n\n![Demo video of running the zig-present software in a terminal session](./doc/demo.gif)\n\n\u003c/div\u003e\n\n## Example\n\nPresentations are expressed in a simple text format. Here's an example presentation:\n\n```txt\n!zig-present\n# Coffee Brewing\n\nHow to brew coffee with a french press\n\n/next_slide\n\n# What you'll need:\n\n- French press\n- Ground coffee beans\n- Boiling water\n\n/next_slide\n\n# Steps\n\n1. Add ground coffee beans to the french press\n2. Add 1 cup of boiling water to the french press, per 7g of coffee beans\n3. Cover the french press with the lid\n4. Wait 8 minutes\n5. Push the plunger down slowly\n6. Pour and enjoy\n```\n\n## Requirements\n\n- Officially supported Zig: `Zig 0.13.0-dev.351+64ef45eb0` (you can get it from the [Zig Releases page](https://ziglang.org/download/))\n\n## Installation\n\nUse Zig to build the application binary. With a shell open in this project's directory:\n\n```\nzig build -Doptimize=ReleaseSafe\n```\n\nThe binary will be available at `zig-out/bin/zig-present`.\n\n## Usage\n\nSee the [Example](#example) for a sample presentation file or the [Presentation](#presentation) section for info on the available presentation commands. Store this in a file with the .txt extension, like `presentation.txt`. Then, you can start the presentation like this:\n\n```\n$ zig-present presentation.txt\n```\n\n## Presentation\n\nEvery zig-present file must start with the line `!zig-present`.\n\nLines starting with a `/` denote a command. All other lines are interpreted as text to print (empty lines and whitespace are preserved).\n\nThe most important command is `/next_slide`, which effectively creates a new slide within the presentation. See [Commands](#commands) for all of the commands.\n\n## Commands\n\nA presentation file can contain pre-defined commands. See the following table for a glossary:\n\n| Command | Description | Example Usage |\n|----|---|---|\n| `/next_slide` | Adds a pause in the presentation, waiting for the user to press enter. Then, will clear the screen and continue the presentation. You may optionally provide a prompt to be displayed beside the cursor. | `/next_slide Go to next slide` |\n| `/docker` | Run the docker command, for example to provide the user with an interactive shell. | `/docker run -it busybox sh` |\n| `/stdout` | Run the shell command and print the result. | `/stdout date` |\n| `/pause` | Adds a pause in the presentation, waiting for the user to press enter. Does not clear the screen when the user hits enter. You may optionally provide a prompt to be displayed beside the cursor. | `/pause Hit enter when you know the answer.` | \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsea-grass%2Fzig-present","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsea-grass%2Fzig-present","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsea-grass%2Fzig-present/lists"}