Skip to content

Commit

Permalink
Add new features to README
Browse files Browse the repository at this point in the history
  • Loading branch information
forgottosave authored Nov 19, 2024
1 parent ca02409 commit 26ed21f
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,15 @@
Welcome to OSTree-TUI. This project provides a more user friendly approach to a OSTree interface. It's purpose is to assist developers when using the command line to interact with OSTree (not to replace the command line interface completely).

## Usage & Features
To start the OSTree-TUI, simply type `ostree-tui <repo_path>` (replace `<repo_path>` with the path to the desired repository), or `ostree-tui --help` to see its options. Navigating the application is possible with the arrow keys, or mouse input. Special actions are described in the bottom-bar.
* **Navigate** all commits on all branches on a `git`-like commit tree
* **View** all details to the selected commit you would also get through an `ostree show`
* **Filter** branches, if the screen gets too buzy for you
* **Drag-and-drop** commits onto branches to promote them (or use `Alt+P`)
* Most features support keyboard input **and** mouse input

The features currently include:
* Display a commit tree on the left
* Branch filter options on the top right
* Display details to the selected commit on the right
To start the OSTree-TUI, simply type `ostree-tui <repo_path>` (replace `<repo_path>` with the path to the desired repository), or `ostree-tui --help` to see its options. Navigating the application is possible with the arrow keys, or mouse input. Special actions are described in the bottom-bar.

Upcoming features can be viewed in the [issues](https://github.com/AP-Sensing/ostree-tui/issues)!
Upcoming features can be viewed in the [issues](https://github.com/AP-Sensing/ostree-tui/labels/%E2%9C%A8%20feature)!

## Installation / Build instructions

Expand All @@ -55,6 +56,7 @@ cmake --build . --parallel
# To install, use `make install DESTDIR=<target_destination>`
```

<!--
**Webassembly build:**
The Webassembly build has not been tested, or confirmed yet.
Expand All @@ -65,3 +67,4 @@ make -j
./run_webassembly.py
(visit localhost:8000)
```
-->

0 comments on commit 26ed21f

Please sign in to comment.