~nytpu/dbc-scheme

15e2a25209d9cb11b601bffe3a411e56fb02b662 — nytpu 1 year, 9 months ago c793311
update readme
1 files changed, 24 insertions(+), 30 deletions(-)

M README.md
M README.md => README.md +24 -30
@@ 3,33 3,40 @@
TODO


## Features
## Rationale


TODO


## Installing
## Documentation

Binaries can be downloaded from blah blah blah.
- The [package documentation on Snow]()
- [contracts.scm](contracts.scm)


## Compiling
## Installing
### Requirements

- POSIX-compatible sh(1).
- POSIX-compatible make(1).  Most makes (including GNU Make and BSD Make)
  support the POSIX standard.
- C compiler and libc supporting the C99 and POSIX.1-2001 standard.
- [R7RS](https://docs.scheme.org/guide/portable-r7rs/)-compliant Scheme
  implementation
- [SRFI 1](https://srfi.schemers.org/srfi-1/) implementation
- [SRFI 64](https://srfi.schemers.org/srfi-64/) implementation (optional, only
  for tests)
- [Chibi Scheme's](http://synthcode.com/wiki/chibi-scheme)
  [`snow-chibi`](http://synthcode.com/scheme/chibi/#h2_SnowPackageManager)
  (optional)

The library can be installed directly from [Snow](http://snow-fort.org/):

### Building
    snow-chibi install nytpu.contracts

    git clone https://git.sr.ht/~nytpu/dbc-scheme && cd dbc-scheme
    ./configure
    make
    sudo make install
Alternately you can clone the repository, or
[download a tarball from Snow]()
and directly include the library in your project.

See `./configure -h` for available options.
Once the library is available, you can then use the library via
`(include (nytpu contracts))`


## Contributing


@@ 45,23 52,10 @@ If you have a very large set of changes, please use
sending a large patchset.


## See Also

- [dbc-scheme](dbc-scheme.1)


## Copyright

Copyright (C) 2022 nytpu <alex [at] nytpu.com>.

Licensed under the terms of the Mozilla Public License version 2.0.  You can view a copy of
the GNU AGPL in [LICENSE](LICENSE) or at <https://www.mozilla.org/en-US/MPL/2.0/>.


## Standards

The build system and source code all conform to IEEE Std 1003.1-2001
("POSIX.1") and ISO/IEC 9899:1999 ("ISO C99") in all cases where the said
standards are applicable.

The documentation conforms to CommonMark Version 0.30 or mandoc Version 1.14.
Licensed under the terms of the Mozilla Public License version 2.0.  You can
view a copy of the MPL in [LICENSE](LICENSE) or at
<https://www.mozilla.org/en-US/MPL/2.0/>.