Add readme.md work for 1.0.3 release

This commit is contained in:
mmcw-dev 2018-03-16 10:50:55 -04:00
parent 4627382c91
commit 2c76710f91
3 changed files with 91 additions and 14 deletions

View File

@ -4,7 +4,8 @@ An open platform for controlling small-gauge film optical printers (16mm, Super8
------- -------
1. <a href="#intro">Introduction</a> 1. <a href="#intro">Introduction</a>
2. <a href="#download">Downloads</a> 2. <a href="#downloads">Downloads</a>
1. <a href="#usage">Usage</a>
2. <a href="#software">Software</a> 2. <a href="#software">Software</a>
3. <a href="#firmware">Firmware</a> 3. <a href="#firmware">Firmware</a>
3. <a href="#hardware">Hardware</a> 3. <a href="#hardware">Hardware</a>
@ -21,32 +22,47 @@ The `mcopy` project is comprised of software and hardware for optical printers,
* Sequencer desktop app * Sequencer desktop app
* Scripting language, called `mscript`, for orchestrating complex sequences * Scripting language, called `mscript`, for orchestrating complex sequences
* Arduino firmware for projectors, cameras, lights and existing printers * Arduino firmware for projectors, cameras, lights and existing printers
* 3D models of parts used for modifying projectors * 3D models of parts used for modifying projectors and printers
* Schematics for simple Arduino-based electronics
## Downloads <a name="downloads"></a> ## Downloads <a name="downloads"></a>
* [1.0.3](https://github.com/sixteenmillimeter/mcopy/releases/tag/1.0.3) for macOS and Linux (.deb)
For Windows, you can [install from source](https://github.com/sixteenmillimeter/mcopy/tree/master/app#mcopy-desktop-app) for now.
## Usage <a name="usage"></a>
The software requires your hardware to be in place before
## Software <a name="software"></a> ## Software <a name="software"></a>
The mcopy desktop app is an Electron-based project which can be built for Linux, Windows and Mac. The mcopy desktop app is an Electron-based project which can be built for Linux, Windows and macOS.
Pre-built packages will be made available for macOS, initially, with the other two target platforms to follow.
To build the desktop app from source, see the [installation and running instructions](https://github.com/sixteenmillimeter/mcopy/tree/master/app#mcopy-desktop-app).
The desktop software also interoperates with two related projects; the Bluetooth + Wifi capable, Raspberry Pi-based [INTVAL3](https://github.com/sixteenmillimeter/intval3) and the Arduino-based [intval2](https://github.com/sixteenmillimeter/intval2).
## Firmware <a name="firmware"></a> ## Firmware <a name="firmware"></a>
This project contains Arduino formware for controlling: This project contains Arduino formware for controlling:
* projector * a projector
* camera (see [intval2](https://github.com/sixteenmillimeter/intval2.git) for more info) * a camera (see [intval2](https://github.com/sixteenmillimeter/intval2) for more info)
* light * a light
* projector + camera * a projector + a camera
* projector + light * a projector + a light
* camera + light * a camera + a light
* projector + camera + light * a camera + a projector + a light
Using a simple interface, this modular platform can be used to control custom-built and modified legacy optical printers. Using a simple serial interface, this modular platform can be used to control DIY components, modified existing optical printers or a mixture of components.
The desktop app can connect to multiple serial devices, so your mcopy optical printer can be built from various designs that suit your hardware tastes/needs/available parts.
## Hardware <a name="hardware"></a> ## Hardware <a name="hardware"></a>
All hardware for this project is available as plaintext OpenSCAD files and 3D print-able .STL files. The hardware component of this project is aimed at modifying broken Bell & Howell projectors into USB serial-controlled projectors to be used in optical printing. All non-electronic hardware for this project is available as plaintext OpenSCAD files and 3D print-able .STL files.
The hardware component of this project is aimed at modifying broken Bell & Howell projectors into USB serial-controlled projectors to be used in optical printing.
As a secondary capability, this desktop software and firmware package can be used to replace the sequencers for early-model JK optical printers, with some modification.
## Why? <a name="why"></a> ## Why? <a name="why"></a>

View File

@ -6,10 +6,69 @@
## Installation ## Installation
The mcopy desktop app can be either [installed from a binary (on Mac)](https://github.com/sixteenmillimeter/mcopy/releases/tag/1.0.0) The mcopy desktop app can be either [installed from a binary (on macOS)](https://github.com/sixteenmillimeter/mcopy/releases) or built from source on any platform that supports node.js and [Electron apps](https://electronjs.org/).
### Mac ### Dependencies
* git
* [node.js](https://nodejs.org/en/)
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](https://brew.sh/).
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](https://nodejs.org/en/download/).
### Linux ### Linux
#### Installing node.js on Linux
See this helpful document from the [node.js Foundation](https://nodejs.org/en/download/package-manager/) 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 ### Windows
#### Installing node.js on Windows
Install node.js on Windows using one of their [many install options](https://nodejs.org/en/download/).

2
docs/Readme.md Normal file
View File

@ -0,0 +1,2 @@
## Using the mcopy desktop app