mcopy/app
mmcwilliams 00b26719f6 Finish renaming UI files digital->filmout 2019-06-18 15:40:09 -04:00
..
assets/icons New icons 2018-03-14 23:15:01 -04:00
css Add the film out screen and begin styling. 2019-06-15 11:05:29 -04:00
data Only use webview in full screen mode for now on all platforms. EOG is trickier and flickers the entire screen into view between frames, which is unsettling. Will look for a lower-level solution than webviews, but works for now. Also, uses real fullscreen on macOS instead of just maximizing the window. 2019-06-18 13:47:55 -04:00
fonts Fixed font-awesome 2016-04-13 17:36:12 -04:00
js Finish renaming UI files digital->filmout 2019-06-18 15:40:09 -04:00
less All film out work from Friday. Re-structure the display module into 3 classes instead of a mess of functions. 2019-06-15 11:06:39 -04:00
lib Rename UI files 2019-06-18 15:25:28 -04:00
scripts Begin refactoring devices.js and create a new digital.js lib for the film-out features. Maybe think of renaming now, before it hurts. 2019-06-18 15:18:08 -04:00
src Finish renaming UI files digital->filmout 2019-06-18 15:40:09 -04:00
test Update delay, exec and exit usage and require statments. 2019-06-08 21:43:14 -04:00
test_old Re-writing mscript tests. 2019-05-28 17:40:59 -04:00
.gitignore Hardcode cfg.json with all the new command characters. 2018-01-09 23:02:47 -05:00
Readme.md Add readme.md work for 1.0.3 release 2018-03-16 10:50:55 -04:00
display.html Add new display and capture modules. Don't need new capture module rn. 2019-02-08 13:16:42 -05:00
gulpfile.js Update all modules, and update gulpfile to gulp4 syntax. 2019-06-14 13:11:28 -04:00
index.html Add the film out screen and begin styling. 2019-06-15 11:05:29 -04:00
main.js Update delay, exec and exit usage and require statments. 2019-06-08 21:43:14 -04:00
package-lock.json Update all modules, and update gulpfile to gulp4 syntax. 2019-06-14 13:11:28 -04:00
package.json Only use webview in full screen mode for now on all platforms. EOG is trickier and flickers the entire screen into view between frames, which is unsettling. Will look for a lower-level solution than webviews, but works for now. Also, uses real fullscreen on macOS instead of just maximizing the window. 2019-06-18 13:47:55 -04:00

Readme.md

mcopy desktop app

  1. Installation

Installation

The mcopy desktop app can be either installed from a binary (on macOS) or built from source on any platform that supports node.js and Electron apps.

Dependencies

Once node is installed (see below for platform-specific instructions) open your terminal application and enter the following commands:

git clone https://github.com/sixteenmillimeter/mcopy.git
cd mcopy/app
npm install

That's it. Once the npm install process is complete, the app can be launched with:

npm start

If you are interested in running in dev mode, simply use:

npm run dev

macOS

Installing node.js on macOS

The node.js runtime can be easily installed on macOS if you already have Homebrew. Simply install node.js with the command:

brew install node

If you're not using Homebrew, you can also install it from the node.js website.

Linux

Installing node.js on Linux

See this helpful document from the node.js Foundation about installing node.js from different package managers. This will provide more detailed instructions about distro-specific dependencies for node.js and the different packages available. Use a more current version of node, if available. At the time of this writing, development is taking place on node.js version 9.7.1.

Arduino firmware

It's recommended that on linux distributions, you have the Arduino IDE installed for debugging and to ensure that your system serial permissions are configured to communicate with the Arduino devices.

Binary installation

When installing from the pre-built .deb package, you may have to locate the package after installation using the following command:

dpkg -L mcopy-app

In the output, you should see an item like /usr/lib/mcopy-app/mcopy which is the binary that contains the desktop app. I will improve the Linux build process, but will also accept any PRs which improve it as well.

Windows

Installing node.js on Windows

Install node.js on Windows using one of their many install options.