~cricket/zckt

ref: 263472288023d6db9a56c9a865aa2166709a3790 zckt/README -rw-r--r-- 1.3 KiB
26347228c piapiac add some helper functions + a couple of tests 7 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
       _   _
 _____| |_| |
|_ / _| / / _|
/__\__|_\_\__|
    zig ckt parser

ABOUT
    this parser will parse a ckt file into to a stringhashmap
    ckt is a stupid simple file format for notating tables
    you can view more about it on https://sr.ht/~cricket/ckt

USAGE
    dont really use this yet; it's sort of just bodged together to work,
    and tests are lacking / incomplete.

    that being said,
    ---
    const zckt = @import("zckt").Parser;

    // ...
    zkct.parse(data, allocator);
    // returns a table of key/value pairs you can work with,
    // with values being either strings or tables.

DEVELOPMENT
    contributions are welcome to zckt and ckt itself!
    
    don't worry too much about coding style! worry more about the code itself, 
    though, please run `zig fmt` on any changed files before contributing
    and try to follow the zig style guide.

    then, send an email with your patch to ~cricket/zckt-devel@lists.sr.ht
    (unsure how? check out git-send-email.io)

LICENSE
    zckt is free software - it is licensed under the CP/PL license

    this means that you're free to use the software in any way you damn well please,
    as long as the copyright notice and warranty disclaimer are kept intact

    read the LICENSE file for more information

AUTHORS
    do `git shortlog -sne` to show a list of all contributors