updated documentation, small correction in comments
This commit is contained in:
5
.gitignore
vendored
5
.gitignore
vendored
@@ -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
4
codec/README.md
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
# codec
|
||||||
|
|
||||||
|
codec is an example and framework for building custom human readable binary
|
||||||
|
transcription encoders.
|
||||||
@@ -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
|
||||||
|
|||||||
Reference in New Issue
Block a user