Skip to content

Commit

Permalink
feat: change README to generated gif
Browse files Browse the repository at this point in the history
  • Loading branch information
cfoust committed Nov 18, 2023
1 parent 0fec07b commit 87291cd
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- name: Build
run: >
go build
-ldflags "-X github.com/cfoust/cy/pkg/version.Version=\"readme\""
-ldflags "-X github.com/cfoust/cy/pkg/version.Version=readme"
-o stories ./cmd/stories/main.go
- uses: charmbracelet/vhs-action@v1
with:
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
> the time traveling terminal multiplexer
<p align="center">
<img src="gh-assets/screenshot.png" alt="Cy Cover Image">
<img src="https://cfoust.github.io/cy/cy.gif" alt="Cy Cover Image">
</p>

<p align="center">
Expand All @@ -24,6 +24,7 @@
`cy` is an experimental terminal multiplexer that aims to be a simple, modern, and ergonomic alternative to `tmux`. You can find out more in **[the documentation](https://cfoust.github.io/cy/)**.

The `cy` project has a few main goals:
* Be beautiful, fast, and easy-to-use, particularly for users who have not used `tmux` or who are intimidated by its default configuration.
* Allow users to search in and replay any `cy` session.
* Stay simple. `cy` is specifically _not_ a clone of `tmux` and will never have all of its functionality (panes, etc).

- Be beautiful, fast, and easy-to-use, particularly for users who have not used `tmux` or who are intimidated by its default configuration.
- Allow users to search in and replay any `cy` session.
- Stay simple. `cy` is specifically _not_ a clone of `tmux` and will never have all of its functionality (panes, etc).
1 change: 0 additions & 1 deletion ci/cy.tape
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Output docs/book/cy.gif
Set Padding 0
Set Framerate 23
Set PlaybackSpeed 0.5
Set LoopOffset 20%

Hide
Type "./stories -s splash && clear"
Expand Down

0 comments on commit 87291cd

Please sign in to comment.