/Chemrtron

A document viewer; fuzzy match incremental search.

Primary LanguageJavaScript

Chemr

A document viewer; fuzzy match incremental search.

Chemrtron is Chemr on Electron.

Features

  • Create index on-demand
  • Same incremental search user interface to all document

Development

Install Electron

Chemrtron is built with Electron.

npm -g install electron-prebuilt

Clone Repository

git clone https://github.com/cho45/Chemrtron.git

Launch

cd Chemrtron
electron .

Create New Indexer

See Create New Indexer

CONTRIBUTING

See CONTRIBUTING.md

ARCHITECTURE

Chemrtron has 2 browser window (by Electron). One of them is main viewer window and another one is for indexing window which is hidden.

The indexing window is shown under development mode which is switched by settings or menu (View -> Toggle Developer Tools).

A main window and an indexing window is communicate with IPC via Electron main process. (there is no direct connection between them)

BUILD Chemr YOURSELF

Install requirements:

npm install -g electron-packager
npm install -g electron-builder

Build:

./dev/package.sh

output to ./build/releases

RELEASING

  1. Updaste ChangeLog
  2. Edit VERSION file to increment version
  3. git commit -a and git push to uploaded to github
  4. make release creates packages, tag origin/master and upload packages to github releases.

LICENSE

MIT: http://cho45.github.com/mit-license