fold - npm Package Compare versions

Comparing version 0.9.2 to 0.9.3

doc/spec.md

@@ -89,3 +89,7 @@ # [FOLD](https://github.com/edemaine/fold/) Specification (version 1 DRAFT)
 * `file_creator`: The software that created the file (a string).
+  **Recommended** for files output by computer software;
+  less important for files made by hand.
 * `file_author`: The human author (a string).
+* `file_title`: A title for the entire file (a string).
+* `file_description`: A description of the entire file (a string).
 * `file_classes`: A subjective interpretation about what the entire file
@@ -110,5 +114,5 @@ represents (array of strings).  Some standard file classes include
 
+* `frame_author`: The human author (a string).
 * `frame_title`: A title for the frame (a string).
 * `frame_description`: A description of the frame (a string).
-* `frame_author`: The human author (a string).
 * `frame_classes`: A subjective interpretation about what the frame represents
@@ -177,4 +181,5 @@ (array of strings).  Some standard frame classes:
   manifold or planar linkage, this list should be ordered counterclockwise
-  around the vertex.  If the frame is a nonorientable manifold,
-  this list should be cyclicly ordered around the vertex.
+  around the vertex (possibly repeating a vertex more than once).
+  If the frame is a nonorientable manifold, this list should be cyclicly
+  ordered around the vertex (possibly repeating a vertex).
   Otherwise, the order is arbitrary.
@@ -184,3 +189,13 @@ **Recommended** in any frame lacking `edges_vertices` property
   `edges_vertices` as needed).
-* `vertices_faces`: 
+* `vertices_faces`: For each vertex, an array of face IDs for the faces
+  incident to the vertex.  If the frame represents an orientable manifold,
+  this list should be ordered counterclockwise around the vertex
+  (possibly repeating a face more than once).  If the frame is a nonorientable
+  manifold, this list shoudl be cyclicly ordered around the vertex
+  (possibly repeating a vertex), and matching the cyclic order of
+  `vertices_vertices` (if both are specified).
+  In addition to the matching cyclic order, `vertices_vertices` and
+  `vertices_faces` should align in start so that
+  `vertices_faces[v][i]` contains vertices `vertices_vertices[v][i]` and
+  `vertices_vertices[v][(i+1)%d]` where `d` is the degree of vertex `v`.
 
@@ -187,0 +202,0 @@ ## Edge information: `edges_...`

package.json

 {
   "name": "fold",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "description": "FOLD file format for origami models, crease patterns, etc.",
   "main": "lib/index.js",
   "bin": {
-    "fold-convert": "lib/convert_file.js"
+    "fold-convert": "lib/file.js"
   },
@@ -9,0 +9,0 @@ "scripts": {

README.md

@@ -1,2 +0,3 @@
-# FOLD
+# FOLD [[spec](doc/spec.md), [viewer](https://edemaine.github.io/fold/examples/foldviewer.html), [API](doc/api.md)]
+
 **FOLD** (Flexible Origami List Datastructure) is a file format (with extension
@@ -3,0 +4,0 @@ `.fold`) for describing **origami models**: crease patterns, mountain-valley

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

171710

increased by4.63%

Number of package files

22

increased by10%

Number of lines in readme file

76

increased by1.33%

No dependency changes