Skip to content

Commit 26ed21f

Browse files
authored
Add new features to README
1 parent ca02409 commit 26ed21f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,15 @@
2525
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).
2626

2727
## Usage & Features
28-
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.
28+
* **Navigate** all commits on all branches on a `git`-like commit tree
29+
* **View** all details to the selected commit you would also get through an `ostree show`
30+
* **Filter** branches, if the screen gets too buzy for you
31+
* **Drag-and-drop** commits onto branches to promote them (or use `Alt+P`)
32+
* Most features support keyboard input **and** mouse input
2933

30-
The features currently include:
31-
* Display a commit tree on the left
32-
* Branch filter options on the top right
33-
* Display details to the selected commit on the right
34+
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.
3435

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

3738
## Installation / Build instructions
3839

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

59+
<!--
5860
**Webassembly build:**
5961
6062
The Webassembly build has not been tested, or confirmed yet.
@@ -65,3 +67,4 @@ make -j
6567
./run_webassembly.py
6668
(visit localhost:8000)
6769
```
70+
-->

0 commit comments

Comments
 (0)