search

quixdb / squash

Compression abstraction library and utilities
https://quixdb.github.io/squash/
MIT License
405 stars 53 forks source link

[Documentation] Usage #208

Closed umbreon222 closed 8 years ago

umbreon222 commented 8 years ago

Is there a possibility to get some documentation on setup, install, and usage?

nemequ commented 8 years ago

https://github.com/quixdb/squash/blob/master/docs/building.md and https://github.com/quixdb/squash/blob/master/docs/user-guide.md. There are also some basic examples in the examples/ directory.

Both documents are also available on the web site for 0.7.0 (see the documentation item in the menu, the user guide is part of the C API reference). It's also possible to build the C API reference from git if you want; just install doxygen and make doc should work.

Is that sufficient, or did you have something else in mind? I'm definitely open to any ideas for improving the documentation…

umbreon222 commented 8 years ago

Ahh, Thanks for the clarification. The documentation provided is definitely sufficient.