Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
lusingander committed Sep 15, 2024
1 parent 5101032 commit 132c12e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Before reporting, please check if an issue with the same content already exists.
When reporting a bug, please include the following information:

- Application version
- `serie --version`
- Version of the terminal emulator and the OS it's running on
- Information about the git repository to reproduce the issue
- If possible, provide the smallest possible repository (debugging a repository with 100,000 commits is difficult)
Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A rich git commit graph in your terminal, like magic 📚

<img src="./img/demo.gif">

(This demo shows [Ratatui](https://github.com/ratatui-org/ratatui) repository!)
(This demo shows [Ratatui](https://github.com/ratatui/ratatui) repository!)

## About

Expand All @@ -27,6 +27,7 @@ Personally, I found the output from `git log --graph` difficult to read, even wi

- Implement a fully-featured Git client.
- Create a TUI application with a complex UI.
- Works in any terminal environment.

## Requirements

Expand Down Expand Up @@ -298,6 +299,10 @@ The terminals on which each has been confirmed to work are listed below.
| ----------------------------------------- | ------- | ---- |
| [kitty](https://sw.kovidgoyal.net/kitty/) || |

### Terminal multiplexers

Terminal multiplexers (tmux, Zellij, etc.) are not supported.

### Reporting Compatibility

Please share your experience with other terminal emulators on the [Discussions](https://github.com/lusingander/serie/discussions/29).
Expand All @@ -318,7 +323,7 @@ Contributions that do not follow these guidelines may not be accepted.

The following repositories are used as these examples:

- [ratatui-org/ratatui](https://github.com/ratatui-org/ratatui)
- [ratatui/ratatui](https://github.com/ratatui/ratatui)
- [charmbracelet/vhs](https://github.com/charmbracelet/vhs)
- [lusingander/stu](https://github.com/lusingander/stu)

Expand Down

0 comments on commit 132c12e

Please sign in to comment.