scottie modes added ; with dayton paper copy
This commit is contained in:
72
readme.md
72
readme.md
@@ -1,12 +1,79 @@
|
||||
# sstv e36 encoder
|
||||
|
||||
This is a simple C SSTV Robot36 encoder!
|
||||
Written in pure C
|
||||
This is a SSTV encoder, currently it is in work, but it has some modes already:
|
||||
|
||||
|Support?|Mode |
|
||||
|--------|------------|
|
||||
|[x] |Martin 1 |
|
||||
|[x] |Martin 2 |
|
||||
|[x] |Robot 36 |
|
||||
|[x] |Scottie 1 |
|
||||
|[x] |Scottie 2 |
|
||||
|[x] |ScottieD(S)X|
|
||||
|
||||
|
||||
Written in _pure_ **C**
|
||||
|
||||
## License:
|
||||
|
||||
This project is distributed under the MiT License!
|
||||
|
||||
### For developing or adding to the source code:
|
||||
|
||||
_**This is just standard C17 Standard**_
|
||||
|
||||
Compilation is done via the gcc compiler, we do NOT allow MSVC here.
|
||||
If you are on Windows then i suggest to use the WSL.
|
||||
|
||||
Be sure to follow this style of code, it is not that complex,
|
||||
and some parts you can even tell Vim or Emacs or whatever you use to automate it,
|
||||
like the header definitions (default i think on vs and some others).
|
||||
|
||||
#### Headers:
|
||||
|
||||
Try to follow this general pattern.
|
||||
In of itself it is relativley easy to maintain this structure.
|
||||
And it is also relativley easy to write in this style!
|
||||
|
||||
_**This is just standard C17 Standard**_
|
||||
```h
|
||||
#ifndef HEADER_H
|
||||
#define HEADER_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
typedef struct {
|
||||
uint8_t type;
|
||||
} mystruct_t;
|
||||
|
||||
int method_to_use(mystruct_t type);
|
||||
|
||||
#endif // !HEADER_H
|
||||
```
|
||||
|
||||
#### C Files:
|
||||
|
||||
For a real implementation this stub below would make 0 sense,
|
||||
but this is the general style you should follow, it includes CAPITAL definitions,
|
||||
local imports in "" and at the top, others below.
|
||||
|
||||
Try to comment your code if it does not make sense.
|
||||
If you encounter something like `Q_rsqrt` (The Quake inverse square root), then you are
|
||||
permitted to comment some swear words.
|
||||
|
||||
Great example of commenting : "robot36.c"
|
||||
|
||||
```c
|
||||
#include "header.h"
|
||||
|
||||
#define PI 3
|
||||
#define SOME_DEF 67
|
||||
|
||||
int method_to_use(mystruct_t type) {
|
||||
return 67 * type;
|
||||
}
|
||||
```
|
||||
|
||||
### Our License:
|
||||
#### MIT :
|
||||
```
|
||||
@@ -36,3 +103,4 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user