Cosmetic changes - file renames, text updates

.circleci/config.yml

@@ -31,23 +31,23 @@ jobs:
       - run:
           name: Build app for Linux
           command: |
-            npm run pack -- --targets linux
+            npm run build -- --targets linux
             cd dist
             tar czf ./RemoteStack-Player-linux-b$(echo $CIRCLE_BUILD_NUM).tar.gz ./RemoteStack-Player-linux
             rm -r ./RemoteStack-Player-linux
 
       - run:
           name: Build app for Mac
           command: |
-            npm run pack -- --targets mac
+            npm run build -- --targets mac
             cd dist
             tar czf ./RemoteStack-Player-mac-b$(echo $CIRCLE_BUILD_NUM).tar.gz ./RemoteStack-Player-mac
             rm -r ./RemoteStack-Player-mac
 
       - run:
           name: Build app for Windows
           command: |
-            npm run pack -- --targets win
+            npm run build -- --targets win
             cd dist
             tar czf ./RemoteStack-Player-win-b$(echo $CIRCLE_BUILD_NUM).tar.gz ./RemoteStack-Player-win
             rm -r ./RemoteStack-Player-win

contributing.md

@@ -1,65 +1,16 @@
 # Contributing
 
-Thanks for making your way to this file, the more the merrier :)
+Thanks for making your way to this file, the more the merrier.
 
 If you'd like to contribute to the project you should start by
-[raising an issue](https://github.com/vot/remotestack-player/issues)
-and explaining what you would like to be changed.
+looking at the [project board](https://github.com/vot/remotestack-player/projects/1)
+to see the current list of tasks.
 
-Feel free to create pull requests but you should still raise an issue first
-to explain the reasoning behind it for the sake of visibility.
+The backlog is rather large (and still growing) so you can pick something for yourself.
 
-If you don't know where to start - this file used to be a roadmap.
-Below is the list of things that I have so far planned. It is rather large
-(and still growing) so you can pick something from here for yourself.
+Whether you have a bug you'd like to report and potentially fix or you would
+like to implement a new feature you should go ahead and
+[raise an issue](https://github.com/vot/remotestack-player/issues).
 
-You should begin with having a look through codebase to try to make some sense
-of it - it's currently at prototype quality so expect the implementation of
-many things to be rough.
-
-After you've picked something please raise an issue briefly explaining
-what it is you'd like to do. You can use an item from the list as issue title
-and just start a conversation.
-Don't hesitate to ask questions if something's not clear.
-
-
-# Task list
-
-## Top TODOs
-
-* Delete cache on exit
-* Persist cache on request (on per-track basis)
-* Add proper right click interaction
-* Multiple playlists + feeds
-
-
-## Known issues
-* Not stopping at the end of the playlist (repeating last track)
-* Repeated deletions with icon switch active item
-* Format support is limited
-* Track caching needs a progress meter + lock
-* No autoupdate
-
-
-## Backlog
-* Fetching videos on request
-* Remote source search
-* UI: Custom range inputs
-* UI: Selectable and multi-selectable items in playlist
-* UI: Right click menu on selected playlist items
-* Renderer: New common adapter to support webaudio and webvideo (Replace Wavesurfer)
-* Clean up playlist and file resolutions (not all metadata is needed)
-* Loops / mark playable sections
-* System tray icon
-* Allow custom key mapping
-* Change rendering engine (Vue?)
-* All UI to be event driven
-* Basic Support for video
-* Optimised caching system
-* Caching options (persistence, limits)
-* Exporting playlists
-* Custom front-end components (waveform, custom sliders, good right click support/gestures)
-* Evaluate alternative playback engines (ffplay? ffserver?)
-* Support for auto-updating channels/feeds
-* Remote streaming
-* Controlling remote instances of player
+Feel free to create pull requests but please make sure to give
+a brief explanation about what your code does.

package.json

@@ -6,10 +6,11 @@
   "scripts": {
     "start": "electron .",
     "lint": "eslint .",
-    "pack": "node ./scripts/pack.js"
+    "build": "node ./scripts/build.js"
   },
   "author": "Vot Z <http://vot-z.com>",
-  "license": "GPL",
+  "repository": "https://github.com/vot/remotestack-player",
+  "license": "GPL-2.0",
   "dependencies": {
     "async": "^2.1.2",
     "clarg": "0.0.3",

scripts/pack.js → scripts/build.js

@@ -42,7 +42,7 @@ function clean(active, callback) {
 /**
  * Pack the app for a single platform
  */
-function packOne(platform, callback) {
+function buildSingleTarget(platform, callback) {
   console.log('Packaging app for', platform);
 
   let platformCode,
@@ -101,11 +101,11 @@ function packOne(platform, callback) {
     if (stdout) console.log('[pack ' + platform + ']', stdout);
     if (stderr) console.log('[pack ' + platform + ']', stderr);
 
-    postPackOne(platform, callback);
+    postBuildSingleTarget(platform, callback);
   });
 }
 
-function postPackOne(platform, callback) {
+function postBuildSingleTarget(platform, callback) {
   // todo: rename dirs here
   let nameIn;
   let nameOut;
@@ -137,7 +137,7 @@ function postPackOne(platform, callback) {
   }
 }
 
-function pack(targets, cleanDist) {
+function buildMultiple(targets, cleanDist) {
   const allTargets = ['mac', 'win', 'linux', 'linux-arm'];
   let buildTargets = targets ? targets.split(',') : allTargets;
   buildTargets = buildTargets.filter(function (tg) {
@@ -151,7 +151,7 @@ function pack(targets, cleanDist) {
 
   clean(cleanDist, function () {
     async.eachSeries(buildTargets, function (i, cb) {
-      packOne(i, cb);
+      buildSingleTarget(i, cb);
     }, function () {
       console.log('All done.');
       process.exit(0);
@@ -162,4 +162,4 @@ function pack(targets, cleanDist) {
 
 const targets = clarg.opts.t || clarg.opts.targets;
 const cleanDist = !!(clarg.opts.c || clarg.opts.clean);
-pack(targets, cleanDist);
+buildMultiple(targets, cleanDist);