Giter Club home page Giter Club logo

chemrtron's Introduction

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

chemrtron's People

Contributors

cho45 avatar hotchpotch avatar kentaro avatar m-ueno avatar mattn avatar r7kamura avatar rhysd avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.