improve docs

pull/2133/head
Mikael Finstad 1 year ago
parent 617731b86c
commit b32d1958e5
No known key found for this signature in database
GPG Key ID: 25AB36E3E81CBC26

@ -122,7 +122,7 @@ If you prefer to download the executables manually, this will of course always b
If you find LosslessCut useful, I'm very thankful for [your support](https://github.com/mifi/lossless-cut#donate-).
**What's the difference between App Stores and GitHub download?** [Please see FAQ](issues.md#app-stores-and-github-difference)
What's the **difference between App Stores and GitHub download?** [Please see FAQ](issues.md#app-stores-and-github-difference)
### Nightly builds 🧪
@ -166,6 +166,8 @@ Codecs and formats not listed above can still be converted to a supported format
- Press <kbd>SHIFT</kbd> + <kbd>/</kbd> to view all keyboard & mouse shortcuts.
- **Note:** The original video file will not be modified. Instead, a file is created file in the same directory as the original file with from/to timestamps in the file name.
## [Installation](./installation.md)
## [Import / export](import-export.md)
## [Command line interface (CLI)](cli.md) & [HTTP API](api.md)

@ -37,7 +37,7 @@ LosslessCut --settings-json '{captureFormat:"jpeg", "keyframeCut":true}'
- `--disable-networking` Turn off all network requests.
- `--http-api` Start the [HTTP server with an API](./api.md) to control LosslessCut, optionally specifying a port (default `8080`).
- `--keyboard-action` Run a keyboard action (see below.)
- `--config-dir` Path to a directory where the `config.json` file will be stored and loaded from.
- `--config-dir` Path to a directory where the `config.json` file will be stored and loaded from. Note: don't include `config.json` in the path (only the directory containing it).
## Controlling a running instance (experimental)

@ -0,0 +1,42 @@
# Installation and files
## There is no installer
There is no installer. The app is just a compressed file that you download from [GitHub](https://github.com/mifi/lossless-cut/releases) and extract. Then you run the executable contained within.
- Windows: Download the `.7z` file and extract it using [7zip](https://www.7-zip.org/download.html).
- MacOS: Mount the `dmg` and drag the app into your `Applications` folder.
- Linux: Y'all know what to do ;)
## Portable app?
LosslessCut is **not** a portable app. If you install it from the Mac App Store or Microsoft Store, it is somewhat portable because it will be containerized by the operating system, so that when you uninstall the app there will most likely not be many traces of it left. You *can* however customise where settings are stored, see below.
## Settings and temporary files
Settings, logs and temporary cache files are stored in your [`appData`](https://www.electronjs.org/docs/api/app#appgetpathname) folder.
### `appData` folder:
| OS | Path |
|-|-|
| Windows | `%APPDATA%\LosslessCut` |
| MacOS | `~/Library/Application Support` |
| Linux | `$XDG_CONFIG_HOME/LosslessCut` or `~/.config/LosslessCut` |
[What is Windows `%APPDATA%`?](https://superuser.com/questions/632891/what-is-appdata)
Settings and keyboard actions are stored inside the `config.json` file inside your `appData` folder.
### Custom `config.json` path
On Windows, if you create a `config.json` file with the contents `{}` next to the `LosslessCut.exe` file, LosslessCut will read/store settings from this file instead of the one inside `appData`. Note that other temporary files will still be stored in `appData`. Alternatively you can specify a custom path to a folder containing `config.json` by using the [CLI option](./cli.md) `--config-dir`. See also [#645](https://github.com/mifi/lossless-cut/issues/645).
## How to uninstall
Just delete the folder/app that you extracted when you installed it.
If you want to also delete all settings, logs and caches, see [Settings and temporary files](#settings-and-temporary-files) above. See also [#2058](https://github.com/mifi/lossless-cut/issues/).
## Unofficial versions
Because LosslessCut is Open Source (GPL), there are many people and organizations who publish their own variant of LosslessCut for example portableapps.com. This is fine, however **I don't provide support for those versions**.

@ -10,8 +10,8 @@
- I have limited time and I have a lot of projects to work on, so I cannot promise any timeline. I will usually prioritize the issues with the most likes, [see here for a list of the most popular issues](https://github.com/mifi/lossless-cut/issues/691).
- How to *cut away* a middle part of a video?
- Enable "advanced view" and then click the Yin Yang symbol. It will invert the segments.
- Where is application data, settings and temp files stored?
- Electron's [appData](https://www.electronjs.org/docs/api/app#appgetpathname) folder: `%APPDATA%/LosslessCut` on Windows. `~/Library/Application Support/LosslessCut` on macOS. `$XDG_CONFIG_HOME/LosslessCut` or `~/.config/LosslessCut` on Linux. LosslessCut is **not** a [portable app.](https://github.com/mifi/lossless-cut/issues/645)
- Is LosslessCut a portable app? Where is application data, settings and temp files stored?
- See LosslessCut is *not* a [portable app](https://github.com/mifi/lossless-cut/issues/645). See [Installation and files](./installation.md).
- Can I export and replace the input file in-place?
- No, but you can export and automatically delete the input file.
- Can you publish through [winget](https://github.com/mifi/lossless-cut/issues/1279), [Flatpak](https://github.com/mifi/lossless-cut/pull/1813), [Docker](https://github.com/mifi/lossless-cut/issues/1086) or other software mangers?
@ -104,16 +104,15 @@ If the output file name has special characters that get replaced by underscore (
- Completely white window when starting up?
- Try to run with `--disable-gpu` - See [781](https://github.com/mifi/lossless-cut/issues/781).
- How to uninstall LosslessCut?
- There is no installer. Just delete the folder. Settings and temp files are stored in your [appData](https://www.electronjs.org/docs/api/app#appgetpathname) folder.
- There is no installer. Just delete the folder. [More info](./installation.md).
- Preview of H265/HEVC files is completely black or corrupted?
- Go to settings and disable "Hardware HEVC decoding".
- Video preview playback slow or stuttering inside LosslessCut?
- See [#922](https://github.com/mifi/lossless-cut/issues/922) [#1904](https://github.com/mifi/lossless-cut/issues/1904) [#1915](https://github.com/mifi/lossless-cut/issues/1915) [#922](https://github.com/mifi/lossless-cut/issues/922)
- Where did the `.exe`/`.zip` downloads go?
- I decided to stop distributing exe and instead just 7zip, due to the [problems that the exe download was causing and the large size of zips.](https://github.com/mifi/lossless-cut/issues/1072#issuecomment-1066026323).
- [APPX is not signed and **does not work**.](https://github.com/mifi/lossless-cut/issues/337) Please use [7z package](https://github.com/mifi/lossless-cut/releases/latest/download/LosslessCut-win-x64.7z) instead.
- I'm getting a KERNEL32.dll error
- It's probably because you're running Windows 7, 8 or 8.1 which are [no longer supported.](https://github.com/mifi/lossless-cut/discussions/1476)
- Why no `.exe`/`.zip`/`.appx` downloads?
- I decided to stop distributing exe/zip and instead just [7zip](https://github.com/mifi/lossless-cut/releases/latest/download/LosslessCut-win-x64.7z), due to the [problems](https://github.com/mifi/lossless-cut/issues/1072#issuecomment-1066026323) that the (self-extracting) exe was causing and the large size of `.zip` files. `appx` is unsigned and [**does not work**](https://github.com/mifi/lossless-cut/issues/337).
- I'm getting a `KERNEL32.dll` error
- It's probably because you're running Windows 7, 8 or 8.1 which is [no longer supported.](https://github.com/mifi/lossless-cut/discussions/1476)
# Known limitations

Loading…
Cancel
Save