commit d17fe2278779cc5799cbc22968a90edcc91135d9
parent df8538f85fa23f5159cf45f633e43dd27738ef44
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 24 Mar 2022 15:46:44 +0100
Small update of the smsh documentation
Diffstat:
1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/doc/smsh.5.scd b/doc/smsh.5.scd
@@ -1,5 +1,20 @@
smsh(5)
+; Copyright (C) 2020, 2021, 2022 |Meso|Star> (contact@meso-star.com)
+;
+; This program is free software: you can redistribute it and/or modify
+; it under the terms of the GNU General Public License as published by
+; the Free Software Foundation, either version 3 of the License, or
+; (at your option) any later version.
+;
+; This program is distributed in the hope that it will be useful,
+; but WITHOUT ANY WARRANTY; without even the implied warranty of
+; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+; GNU General Public License for more details.
+;
+; You should have received a copy of the GNU General Public License
+; along with this program. If not, see <http://www.gnu.org/licenses/>.
+
# NAME
smsh - Star-Mesh file format
@@ -34,6 +49,9 @@ Finally, fill bytes are added to align the overall file size to _pagesize_.
# BINARY FILE FORMAT
+Data are encoded with respect to the little endian bytes ordering, i.e. least
+significant bytes are stored first.
+
```
<smsh> ::= <pagesize> <#nodes> <#cells> <dimnode> <dimcell>
<padding>