updated documentation, small correction in comments

This commit is contained in:
David Vennik
2022-02-27 07:11:15 +02:00
parent 70256ddf72
commit cb803b8482
3 changed files with 11 additions and 1 deletions

5
.gitignore vendored
View File

@@ -13,3 +13,8 @@
# Dependency directories (remove the comment below to include it) # Dependency directories (remove the comment below to include it)
# vendor/ # vendor/
/.idea/.gitignore
/.idea/misc.xml
/.idea/modules.xml
/.idea/transcribe.iml
/.idea/vcs.xml

4
codec/README.md Normal file
View File

@@ -0,0 +1,4 @@
# codec
codec is an example and framework for building custom human readable binary
transcription encoders.

View File

@@ -1,4 +1,5 @@
// Package codecer is the interface definition for a Human Readable Binary Codec // Package codecer is the interface definition for a Human Readable Binary
// Transcription Codec
// //
// Interface definitions should be placed in separate packages to // Interface definitions should be placed in separate packages to
// implementations so there is no risk of a circular dependency, which is not // implementations so there is no risk of a circular dependency, which is not