gitignore dist and update links (#908)

* Update .gitignore

* Delete image-sequencer-ui.min.js

* Delete image-sequencer.js

* Delete image-sequencer.min.js

* Update README.md

* Update README.md

* Update CONTRIBUTING.md

* Update .npmignore

* Update README.md

* Update .npmignore

* Update CONTRIBUTING.md
This commit is contained in:
Harsh Khandeparkar
2019-03-26 01:25:34 +05:30
committed by Jeffrey Warren
parent 15e93f09bd
commit a923f48c87
7 changed files with 26 additions and 73647 deletions

6
.gitignore vendored
View File

@@ -27,6 +27,10 @@ build/Release
node_modules node_modules
node_modules/* node_modules/*
# Dist Files
dist/*
dist
# Optional npm cache directory # Optional npm cache directory
.npm .npm
@@ -45,4 +49,4 @@ test/core/modules/test_outputs/*
node_modules/ node_modules/
node_modules/* node_modules/*
test_outputs test_outputs
/test_outputs /test_outputs

View File

@@ -37,6 +37,8 @@ test.js
output.txt output.txt
output/ output/
examples/ examples/
icons/ icons/

View File

@@ -27,7 +27,7 @@ If you find a bug please list it here, and help us develop Image Sequencer by [o
## Contributing modules ## Contributing modules
Most contributions can happen in modules, rather than to core library code. Modules and their [corresponding info files](#info-file) are included into the library in this file: https://github.com/publiclab/image-sequencer/blob/master/src/Modules.js#L5-L7 Most contributions can happen in modules, rather than to core library code. Modules and their [corresponding info files](#info-file) are included into the library in this file: https://github.com/publiclab/image-sequencer/blob/main/src/Modules.js#L5-L7
Module names, descriptions, and parameters are set in the `info.json` file -- [see below](#info-file). Module names, descriptions, and parameters are set in the `info.json` file -- [see below](#info-file).
@@ -142,7 +142,7 @@ input = {
pixelManipulation: "general purpose pixel manipulation API, see https://github.com/publiclab/image-sequencer/blob/master/src/modules/_nomodule/PixelManipulation.js" pixelManipulation: "general purpose pixel manipulation API, see https://github.com/publiclab/image-sequencer/blob/master/src/modules/_nomodule/PixelManipulation.js"
} }
``` ```
For example usage for pixelManipulation see https://github.com/publiclab/image-sequencer/blob/master/src/modules/Invert/Module.js For example usage of pixelManipulation see https://github.com/publiclab/image-sequencer/blob/main/src/modules/Invert/Module.js
**The module is included in the browser inside a script tag and since the code runs directly in the browser if any other module is required apart from the apis available on the input object, it should be either bundled with the module code and imported in es6 format or the module code must be browserified before distribution for browser** **The module is included in the browser inside a script tag and since the code runs directly in the browser if any other module is required apart from the apis available on the input object, it should be either bundled with the module code and imported in es6 format or the module code must be browserified before distribution for browser**
@@ -264,9 +264,9 @@ The `progressObj` parameter of `draw()` is not consumed unless a custom progress
### Module example ### Module example
See existing module `green-channel` for an example: https://github.com/publiclab/image-sequencer/tree/master/src/modules/GreenChannel/Module.js See existing module `channel` for an example: https://github.com/publiclab/image-sequencer/blob/main/src/modules/Channel/Module.js
The `green-channel` module is included into the core modules here: https://github.com/publiclab/image-sequencer/blob/master/src/Modules.js#L5-L7 The `channel` module is included into the core modules here: https://github.com/publiclab/image-sequencer/blob/main/src/Modules.js#L5-L7
For help integrating, please open an issue. For help integrating, please open an issue.

View File

@@ -4,8 +4,9 @@ Image Sequencer
[![Build Status](https://travis-ci.org/publiclab/image-sequencer.svg?branch=master)](https://travis-ci.org/publiclab/image-sequencer) [![Build Status](https://travis-ci.org/publiclab/image-sequencer.svg?branch=master)](https://travis-ci.org/publiclab/image-sequencer)
**Latest Stable Demo**: https://sequencer.publiclab.org - **Latest Stable Demo**: https://sequencer.publiclab.org
**Latest Beta Demo**: https://beta.sequencer.publiclab.org - **Latest Beta Demo**: https://beta.sequencer.publiclab.org
- **Stable Branch**: https://github.com/publiclab/image-sequencer/blob/stable/
## Why ## Why
@@ -20,7 +21,7 @@ The following diagrams attempt to explain how the applications various component
![general diagram](https://publiclab.org/i/30547.png?s=o) ![general diagram](https://publiclab.org/i/30547.png?s=o)
![workflow diagram](https://raw.githubusercontent.com/publiclab/image-sequencer/master/examples/images/diagram-workflows.png) ![workflow diagram](https://raw.githubusercontent.com/publiclab/image-sequencer/main/examples/images/diagram-workflows.png)
It also for prototypes other related ideas: It also for prototypes other related ideas:
@@ -28,15 +29,17 @@ It also for prototypes other related ideas:
* test-based image processing -- the ability to create a sequence of steps that do the same task as other image processing tools, provable with example before/after images to compare with * test-based image processing -- the ability to create a sequence of steps that do the same task as other image processing tools, provable with example before/after images to compare with
* logging each step -- to produce an evidentiary record of modifications to an original image * logging each step -- to produce an evidentiary record of modifications to an original image
* cascading changes -- change an earlier step's settings, and see those changes affect later steps * cascading changes -- change an earlier step's settings, and see those changes affect later steps
* "small modules" -- based extensibility: see [Contributing](https://github.com/publiclab/image-sequencer/blob/master/CONTRIBUTING.md) * "small modules" -- based extensibility: see [Contributing](https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md)
## Examples ## Examples
* [Simple Demo](https://publiclab.github.io/image-sequencer/) * [Simple Demo](https://sequencer.publiclab.org)
* [Latest Beta Demo](https://beta.sequencer.publiclab.org)
A diagram of this running 5 steps on a single sample image may help explain how it works: A diagram of this running 5 steps on a single sample image may help explain how it works:
![example workflow](https://raw.githubusercontent.com/publiclab/image-sequencer/master/examples/images/diagram-6-steps.png) ![example workflow](https://raw.githubusercontent.com/publiclab/image-sequencer/main/examples/images/diagram-6-steps.png)
## Jump to: ## Jump to:
@@ -47,8 +50,8 @@ A diagram of this running 5 steps on a single sample image may help explain how
* [Method Chaining](#method-chaining) * [Method Chaining](#method-chaining)
* [Multiple Images](#multiple-images) * [Multiple Images](#multiple-images)
* [Creating a User Interface](#creating-a-user-interface) * [Creating a User Interface](#creating-a-user-interface)
* [Contributing](https://github.com/publiclab/image-sequencer/blob/master/CONTRIBUTING.md) * [Contributing](https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md)
* [Submit a Module](https://github.com/publiclab/image-sequencer/blob/master/CONTRIBUTING.md#contributing-modules) * [Submit a Module](https://github.com/publiclab/image-sequencer/blob/main/CONTRIBUTING.md#contributing-modules)
* [Get Demo Bookmarklet](https://publiclab.org/w/imagesequencerbookmarklet) * [Get Demo Bookmarklet](https://publiclab.org/w/imagesequencerbookmarklet)
## Installation ## Installation
@@ -56,12 +59,12 @@ A diagram of this running 5 steps on a single sample image may help explain how
This library conveniently works in the browser, in Node, and on the command line (CLI). This library conveniently works in the browser, in Node, and on the command line (CLI).
### Unix based platforms ### Unix based platforms
You can set up a local environment to test the UI with `sudo npm run setup` followed by `npm start` You can set up a local environment to test the UI with `npm run setup` followed by `npm start`.
### Windows ### Windows
Our npm scripts do not support windows shells, please run the following snippet in PowerShell. Our npm scripts do not support windows shells, please run the following snippet in PowerShell.
```powershell ```powershell
npm i ; npm i -g grunt grunt-cli ; grunt serve npm i ; npm i -g grunt grunt-cli ; grunt build; grunt serve
``` ```
In case of a port conflict please run the following In case of a port conflict please run the following
```powershell ```powershell
@@ -70,12 +73,12 @@ npm i -g http-server ; http-server -p 3000
### Browser ### Browser
Just include [image-sequencer.js](https://publiclab.github.io/image-sequencer/dist/image-sequencer.js) in the Head section of your web page. See the [demo here](https://publiclab.github.io/image-sequencer/)! Just include [image-sequencer.min.js](https://github.com/publiclab/image-sequencer/blob/stable/dist/image-sequencer.min.js) in the Head section of your web page. See the [demo here](https://sequencer.publiclab.org)!
### Node (via NPM) ### Node (via NPM)
(You must have NPM for this) (You must have NPM for this)
Add `image-sequencer` to your list of dependencies and run `$ npm install` Add `image-sequencer` to your list of dependencies and run `npm install`
### CLI ### CLI

File diff suppressed because one or more lines are too long

73628
dist/image-sequencer.js vendored

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long