Umbrella repository for quid2 projects
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
flat @ 9531bec
model @ c2601f0
top @ 4ea70d6
top-apps @ 4b69862
top-apps-ghcjs @ 84b7e4d
typed @ 60803aa
.gitmodules
README.md
stack.yaml

README.md

An umbrella repository for projects related to Quid2.

What Is Quid2?

Quid2 (pronounced quidquid) is a general framework for the definition, preservation and sharing of data.

It is composed by a suite of mini-specifications and corresponding reference implementations to:

  • create canonical, language independent, data type definitions
  • convert canonical data values to and from an efficient and principled binary format
  • use a content-oriented transport protocol for large-scale data exchange

What Can It Do For Me?

Ask not what Quid2 can do for you but rather what you can do for Quid2!

Quid2 is under intense development and not all its parts are currently documented and usable.

There is however a part of it that is quite usable and possibly also useful: top, the typed oriented protocol.

Included and Related Projects

Quid2's sub projects are:

  • top-apps-ghcjs
    • Example WWW applications for top, using ghcjs.
  • top-apps
    • Example applications for top.
  • top
    • API for top, the typed oriented protocol.
  • typed
    • Language independent, absolute types.
  • flat
    • Principled and efficient serialization.
  • model
    • Derivation of data type models from Haskell data types.

A related project is router, the message router used to implement the top service.

Installation

git clone --recursive https://github.com/tittoassini/quid2.git;cd quid2;stack build

This will retrieve the whole quid2 suite and build all subprojects except top-apps-ghcjs, as setting up ghcjs takes a long time.

To verify that all works, start up the top-chat program:

stack exec top-chat

Enter your name:
titto

Help:
To send a message: just enter it and press return.
To exit: Ctrl-D.

Current Subject: (Haskell)

Hello!

That's it!

Support

Problems? Questions? Open an Issue on this repository or write directly to titto at: tittoassini@gmail.com