From 596a73d756ebd15d221cb3782b23f1d676b97175 Mon Sep 17 00:00:00 2001 From: Mikael Finstad Date: Tue, 22 May 2018 23:32:54 +0200 Subject: [PATCH] improve readme --- README.md | 29 ++++++----------------------- developer-notes.md | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 23 deletions(-) create mode 100644 developer-notes.md diff --git a/README.md b/README.md index 6bff9ad0..d0c63b26 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,12 @@ Simple, cross platform tool for lossless trimming/cutting of video and audio fil ## Supported formats -Since LosslessCut is based on Chromium and uses the HTML5 video player, not all ffmpeg supported formats will be supported. +Since LosslessCut is based on Chromium and uses the HTML5 video player, not all ffmpeg supported formats will be supported directly. The following formats/codecs should generally work: MP4, MOV, WebM, MKV, OGG, WAV, MP3, AAC, H264, Theora, VP8, VP9 For more information about supported formats / codecs, see https://www.chromium.org/audio-video. -Note that the MPEG TS format is not supported. See known issues. + +**New in v1.11.0:** Unsupported files can now be remuxed (fast) or encoded (slow) to a friendly format/codec from the `File` menu. A processed version of the file will then be opened in the player. The cut operation will still be performed using the original file as input. This allows for potentially opening any file that ffmpeg is able to decode. + ## Typical workflow - Drag drop a video file into player to load or use /CTRL+O. @@ -46,8 +48,6 @@ https://github.com/mifi/lossless-cut/blob/41d6991c11b0a82b08344fd22a1ea094af2174 ## Known issues - Some output videos will have an empty portion in the beginning (you might lose a few seconds after your in-cutpoint). A tip is to set the cutpoint a few extra seconds before the part you want to keep, that way you will not lose anything. See discussion in [#13](https://github.com/mifi/lossless-cut/pull/13) - If you get an error when cutting any kind of file under Windows, please check your anti-virus. It might be blocking execution of ffmpeg, see [#18](https://github.com/mifi/lossless-cut/issues/18) -- Unsupported files can be losslessly remuxed to for example mp4 first with the following command: `ffmpeg -i input.ts -acodec copy -vcodec copy out.mp4` - ## Development building / running @@ -55,7 +55,7 @@ This app is built using Electron. Make sure you have at least node v6 and yarn i ``` git clone https://github.com/mifi/lossless-cut.git cd lossless-cut -yarn +npm install ``` ### Running @@ -63,27 +63,10 @@ In one terminal: ``` npm run watch ``` -Then: +In another: ``` npm start ``` -### Release new version -``` -# Commit changes -# Wait for Travis -npm version ... -# Update CHANGELOG.md -# Commit CHANGELOG.md -# Push -npm run download-ffmpeg -npm run extract-ffmpeg -npm run build -npm run icon-gen -npm run package -npm run release - -``` - ## Credits - App icon made by [Dimi Kazak](http://www.flaticon.com/authors/dimi-kazak "Dimi Kazak") from [www.flaticon.com](http://www.flaticon.com "Flaticon") is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0") diff --git a/developer-notes.md b/developer-notes.md new file mode 100644 index 00000000..dace2420 --- /dev/null +++ b/developer-notes.md @@ -0,0 +1,39 @@ +## Release + +### Release new version +``` +# Commit changes +npm version ... +# Update CHANGELOG.md +# Commit CHANGELOG.md +# Push with tag +# Wait for Travis +``` + +With travis deploy: +``` +Go to github releases and release the created draft +``` + +Manual release +``` +npm run download-ffmpeg +npm run extract-ffmpeg +npm run build +npm run icon-gen +npm run package +npm run release +``` + + +## Travis setup + +https://github.com/travis-ci/travis-ci/issues/6132 +https://github.com/bkimminich/juice-shop/blob/master/.travis.yml + +https://stackoverflow.com/questions/12343452/how-to-publish-artifacts-in-travis-ci +https://docs.travis-ci.com/user/deployment/releases/ +https://octokit.github.io/octokit.rb/Octokit/Client/Releases.html#create_release-instance_method + +npm install -g pwmckenna/node-travis-encrypt +echo GITHUB_KEY | travis-encrypt -r mifi/lossless-cut