History

mmcwilliams 8ebdbf9f6f Add docs script to package.json		2019-02-23 12:25:47 -05:00
..
assets/icons	New icons	2018-03-14 23:15:01 -04:00
css	Fix loop bug. When selection a video as a projector (need to work on this metaphor) the loops are automatically set. Previous issues were due to id re-use.	2019-02-11 01:08:20 -05:00
data	Import all work on digital branch into master	2018-10-06 23:38:29 -04:00
fonts	Fixed font-awesome	2016-04-13 17:36:12 -04:00
js	Build new app.js	2018-06-26 09:36:18 -04:00
less	Fix loop bug. When selection a video as a projector (need to work on this metaphor) the loops are automatically set. Previous issues were due to id re-use.	2019-02-11 01:08:20 -05:00
lib	Feeble first attempt at documenting code	2019-02-23 12:25:47 -05:00
scripts	Move all scripts into scripts directory	2019-02-23 12:25:47 -05:00
src	Remove whitespace	2018-06-19 09:49:34 -04:00
test	Update tests for variables features	2018-06-24 16:09:16 -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	Stop building app with mscript.js, gets required by index.js	2018-01-05 15:47:54 -05:00
index.html	Fix loop bug. When selection a video as a projector (need to work on this metaphor) the loops are automatically set. Previous issues were due to id re-use.	2019-02-11 01:08:20 -05:00
main.js	Save and restore settings, including profiles.	2019-02-23 12:25:46 -05:00
package-lock.json	Save and restore settings, including profiles.	2019-02-23 12:25:46 -05:00
package.json	Add docs script to package.json	2019-02-23 12:25:47 -05:00

Readme.md

mcopy desktop app

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

git
node.js

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.