gitignore + README

.gitignore

@@ -1,27 +1,27 @@
-# If you prefer the allow list template instead of the deny list, see community template:
+# If you prefer the allow list template instead of the deny list, see community template:
-# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-#
+#
-# Binaries for programs and plugins
+# Binaries for programs and plugins
-*.exe
+*.exe
-*.exe~
+*.exe~
-*.dll
+*.dll
-*.so
+*.so
-*.dylib
+*.dylib
-
+
-# Test binary, built with `go test -c`
+# Test binary, built with `go test -c`
-*.test
+*.test
-
+
-# Output of the go coverage tool, specifically when used with LiteIDE
+# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
+*.out
-
+
-# Dependency directories (remove the comment below to include it)
+# Dependency directories (remove the comment below to include it)
-# vendor/
+# vendor/
-
+
-# Go workspace file
+# Go workspace file
-go.work
+go.work
-go.work.sum
+go.work.sum
-
+
-# env file
+# env file
-.env
+.env
-
+
 /.idea

README.md

@@ -1,16 +1,16 @@
-# SUD
+# SUD
-SUDOKU FILETYPE
+SUDOKU FILETYPE
-
+
-## Structure
+## Structure
-### HEADER
+### HEADER
-- [ ] Data length
+- [ ] SUD Version (2 Bytes)
-- [ ] HASH
+- [ ] Data length (2 Bytes)
-- [ ] SUD Version
+
-- [ ] Options
+### BODY
-
+- [ ] Title
-### BODY
+- [ ] Author
-- [ ] Title
+- [ ] Rules (Optional)
-- [ ] Author
+- [ ] Board
-- [ ] Rules (Optional)
+
-- [ ] Field
+### Footer
-- [ ] Legend
+- [ ] CRC Checksum