Skip to content

Commit 8d5cb17

Browse files
committed
update README v0.4
1 parent eee8211 commit 8d5cb17

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Introduction
22

3-
This tool scrapes the LLVM-C API and (currently) prints all available API
4-
functions to `stdout`. It came to be from the lack of search options in the
3+
This tool scrapes the LLVM-C API and provides a TUI to search and navigate the
4+
API from the terminal. It came to be from the lack of search options in the
55
[llvm-c](https://llvm.org/doxygen/group__LLVMC.html) official documentation, and
66
difficulty to navigate the hyperlinks as a beginner to llvm.
77

@@ -10,7 +10,10 @@ all apparently related hyperlinks of sub-modules (in
1010
fact, this exact function was the "last-drop", and the reason why I wrote
1111
program), simply run the program, and then filter for `sext` by tapping `/` when the TUI loads.
1212

13-
## v0.3 Preview
13+
Additionally, pressing enter on the selected item will open the corresponding
14+
llvm-c API webpage on the browser.
15+
16+
## v0.4 Preview
1417

1518
Searching for the function that returns the LLVM pointer type of an LLVM type
1619
![Screenshot 2021-12-24 at 23 39 30](https://user-images.githubusercontent.com/21295306/147374322-b5833e04-1300-4b0f-b152-d2f91e970118.png)

TODO

-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
hoogle-like "search by types"
22
TUI start with progress bar
3-
On enter visit webpage

0 commit comments

Comments
 (0)