From 552205063bc76977cd43db229a99c78054f8b879 Mon Sep 17 00:00:00 2001 From: David Sehnal <david.sehnal@gmail.com> Date: Tue, 14 Nov 2017 11:34:43 +0100 Subject: [PATCH] readme + examples folder --- README.md | 10 ++++++++++ src/examples/computation.ts | 1 + 2 files changed, 11 insertions(+) create mode 100644 src/examples/computation.ts diff --git a/README.md b/README.md index 30294cdc0..7cfcb93b9 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ - extending on the ideas of the CIFTools.js library +## Module Overview + +- `mol-comp` Computation abstraction with progress tracking and cancellation support. +- `mol-data` Collections (integer based sets, inteface to columns/tables, etc.) +- `mol-math` Math related (loosely) algorithms and data structures. +- `mol-io` Parsing library. Each format is parsed into an interface that corresponds to the data stored by it. +- `mol-model` Data structures and algorithms (such as querying) for representing molecular data. +- `mol-ql` Mapping of `mol-model` to the MolQL query language spec. +- `mol-util` Useful things that do not fit elsewhere. + ## Building & Running ### Build: diff --git a/src/examples/computation.ts b/src/examples/computation.ts new file mode 100644 index 000000000..0ffdd02fc --- /dev/null +++ b/src/examples/computation.ts @@ -0,0 +1 @@ +// TODO \ No newline at end of file -- GitLab