Skip to content

Commit

Permalink
docs(README): add warning for WSL user
Browse files Browse the repository at this point in the history
I will create the AppImages mainly with CI/CD meaning that it will most
likely not work on WSL unless I create them manually.
  • Loading branch information
eckon committed Sep 27, 2021
1 parent 0a661f2 commit 840a776
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ or [compile the repo manually](#general) and run it.
* Download the Appimage on the Releases page
* Make it executable `chmod +x <file>`
* For systems that can not run it (Windows: WSL)
* *WARNING* for some reason only some AppImages work (for WSL), mainly the ones created manually (tagged with `*-manual`), if the newest version does not have one, check older versions/releases open an Issue or compile on your computer
* Extract it with `./<file> --appimage-extract`
* Run the executable in `./squashfs-root/usr/bin/qc`
* Run it
Expand All @@ -64,6 +65,7 @@ or [compile the repo manually](#general) and run it.


## Config

* Add access token in Gitlab with (at least) API-read permissions
* Can be found in your personal settings under "Access Tokens"
* ~~(Create)~~ Update config file at `~/.config/quick-clone/config.json` (_names etc. might change_)
Expand Down

0 comments on commit 840a776

Please sign in to comment.