mirror of
https://github.com/upscayl/upscayl.git
synced 2025-02-17 11:18:36 +01:00
readme
This commit is contained in:
parent
dc79929e59
commit
364f26a9d2
79
README.md
79
README.md
@ -1,78 +1 @@
|
||||
<p align="center"><img src="https://user-images.githubusercontent.com/25067102/153943381-3ac38273-0195-4206-812a-201dc075c177.png" /></p>
|
||||
|
||||
# <p align="center">DeskCut</p>
|
||||
An easy to use app that lets you create Desktop Shortcuts (.desktop files) on Linux without requiring to mess with `.desktop` files!
|
||||
This lets you add a portable program to your search and system menus with a few simple clicks 😉
|
||||
|
||||
<p align="center"><img src="https://user-images.githubusercontent.com/25067102/153943083-6bcb011c-667f-4e88-89bc-cb8e7ec99ab2.gif" /></p>
|
||||
|
||||
|
||||
## How to use
|
||||
|
||||
Here's a nice article by Linuxiac on how to use DeskCut (Might not be available in a few countries, sorry😅): https://linuxiac.com/deskcut-create-linux-desktop-shortcuts/
|
||||
|
||||
### Manual Installation:
|
||||
Go to the releases section and download DeskCut's latest version, Install and that's it!
|
||||
|
||||
- You can download either the `.deb` or `.rpm` version or the `AppImage`.
|
||||
- Use the `.deb` file to directly install it using your store app. Please remember that `.deb` files only work on Debian based distros like Ubuntu, ZorinOS, PopOS, Mint, KDE Neon, etc. DEB file will not work on Fedora/Manjaro/Arch.
|
||||
- If you use Fedora, you should download the `.rpm` file instead. RPM packages are similar to DEB packages. Just double click (or open with your store app) and install.
|
||||
- AppImage is portable and it works almost everywhere. It should be fine for most people but remember that it doesn't integrate by default. You'll have to run the file everytime you want to use the app because AppImages aren't supposed to be installed on a system. So make sure you use something like <a href="https://github.com/TheAssassin/AppImageLauncher/releases/" target="_blank">AppImage Launcher</a> to properly install it on your system.
|
||||
|
||||
### <a href="#">Download from Snap Store (NO LONGER AVAILABLE)</a>
|
||||
Snap version will no longer be supported due to several issues that come up because of sandboxing. Please use the DEB or the AppImage version till another alternative is provided.
|
||||
|
||||
## Build Instructions
|
||||
|
||||
You'll need `node` and `npm` or `yarn`.
|
||||
### To install node, you can use fnm:
|
||||
```bash
|
||||
`curl -fsSL https://fnm.vercel.app/install | bash`
|
||||
```
|
||||
Add `eval "$(fnm env --use-on-cd)"` to your .bashrc or .zshrc and then
|
||||
```bash
|
||||
source .bashrc
|
||||
OR
|
||||
source .zshrc`
|
||||
```
|
||||
Then type
|
||||
```bash
|
||||
fnm install 16.13.2
|
||||
fnm use 16.13.2
|
||||
```
|
||||
Node is now installed.
|
||||
|
||||
### OPTIONAL: Install Yarn
|
||||
Yarn is not necessary, npm can do exactly the same thing but I used yarn to create this project (Totally irrelevant).
|
||||
But if you still want to use Yarn:
|
||||
```
|
||||
npm install --global yarn
|
||||
```
|
||||
### Set up project
|
||||
Now cd to the location where you cloned this project and run:
|
||||
```bash
|
||||
npm install
|
||||
or
|
||||
yarn install
|
||||
```
|
||||
|
||||
### Run Development Build
|
||||
```bash
|
||||
npm run start
|
||||
OR
|
||||
yarn start
|
||||
```
|
||||
|
||||
### To Package Build
|
||||
```bash
|
||||
npm run dist
|
||||
OR
|
||||
yarn dist
|
||||
```
|
||||
|
||||
## To-Do
|
||||
|
||||
- [x] Dark Mode
|
||||
- [x] Update Dialog for DEBs, RPMs & AppImages
|
||||
- [ ] Auto-Update AppImages?
|
||||
- [ ] Fix bugs (if any left)
|
||||
# Upscayl
|
Loading…
x
Reference in New Issue
Block a user