Skip to content

Commit

Permalink
Better README
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisJefferson committed Dec 22, 2014
1 parent 7e4dbd6 commit 1591a39
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
The GAP 4 package `json'
==============================
The GAP 4 package 'json'
========================

This package defines a mapping between the JSON markup language and GAP.
The built-in datatypes of GAP provide an easy mapping to and from JSON.
This package uses the following mapping between GAP and JSON.

* JSON lists are mapped to GAP lists
* JSON dictionaries are mapped to GAP records
* JSON strings are mapped to GAP strings
* Integers are mapped to GAP integers, non-integer numbers are mapped to Floats
* true, false and null are mapped to true, false and fail respectively

Note that this library will not map any other GAP types, such as groups,
permutatations, to or from JSON. If you wish to map between more complex
types, look at the openmath package, or IO_Pickle in the IO package.

0 comments on commit 1591a39

Please sign in to comment.