Skip to content

Commit bd354e9

Browse files
committed
Mention appimage in readme
1 parent eae8383 commit bd354e9

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
A small cli tool to search and clone git repositories from the terminal (currently only Gitlab-v4 endpoints).
44

5+
56
## Disclaimer
67

78
This is a personal "for-fun" project. It was only tested on my machine and configured to my liking. It is my first "real" c++ and tui project (which is pretty obvious when looking into the code) so please consider this before doing anything.
@@ -13,10 +14,12 @@ If the tool does not work and/or you want another quick solution, have a look at
1314

1415
Run the `qc` command. This will open up the interactive TUI (the [config file](#setup) needs to be added before first usage).
1516

17+
1618
## Example
1719

1820
![Example Usage of quick-clone](./quick-clone-example.gif)
1921

22+
2023
## Views
2124
* Query-Prompt (starting position)
2225
* `UP/DOWN` select between different git endpoints (provided by config file)
@@ -33,8 +36,25 @@ Run the `qc` command. This will open up the interactive TUI (the [config file](#
3336

3437

3538
# Setup
39+
Currently there is no real easy way of installing this tool.
40+
Appimage might work (on linux) but was not tested.
41+
General installing and compiling should work.
42+
43+
44+
## Appimage
3645

37-
* Currently there is no pre-compiled binaries
46+
* Download the Appimage
47+
* Make it executable `chmod +x <file>`
48+
* For systems that can not run it
49+
* Extract it with `./<file> --appimage-extract`
50+
* Run the executable in `./squashfs-root/usr/bin/qc`
51+
* **Warning**: this seems to be not working because some libs are not exported (on my system at least)
52+
* Run it
53+
54+
55+
## General
56+
57+
* Currently there is no pre-compiled binaries (ignoring appimage)
3858
* To install: have the needed [dependencies](#dependencies) and [compile](#commands) the tool on your machine
3959
* Add access token in Gitlab with (at least) API-read permissions
4060
* Can be found in your personal settings under "Access Tokens"
@@ -77,6 +97,7 @@ This should work on most machine that supports bash and the other tools and can
7797

7898

7999
## Commands
100+
80101
```sh
81102
# generate Makefile in build/
82103
$ cmake -S . -B build/
@@ -86,4 +107,7 @@ $ make -C build/
86107

87108
# format repository
88109
$ clang-format -i --style=Google src/**/*.cpp src/**/*.h
110+
111+
# generate appimage
112+
$ ./generate/generate-appimage.sh
89113
```

0 commit comments

Comments
 (0)