README.rst 1.3 KB

12345678910111213141516171819202122232425
  1. Welcome to Kiwi
  2. ===============
  3. .. image:: https://travis-ci.org/nucleic/kiwi.svg?branch=main
  4. :target: https://travis-ci.org/nucleic/kiwi
  5. .. image:: https://github.com/nucleic/kiwi/workflows/Continuous%20Integration/badge.svg
  6. :target: https://github.com/nucleic/kiwi/actions
  7. .. image:: https://github.com/nucleic/kiwi/workflows/Documentation%20building/badge.svg
  8. :target: https://github.com/nucleic/kiwi/actions
  9. .. image:: https://codecov.io/gh/nucleic/kiwi/branch/main/graph/badge.svg
  10. :target: https://codecov.io/gh/nucleic/kiwi
  11. .. image:: https://readthedocs.org/projects/kiwisolver/badge/?version=latest
  12. :target: https://kiwisolver.readthedocs.io/en/latest/?badge=latest
  13. :alt: Documentation Status
  14. Kiwi is an efficient C++ implementation of the Cassowary constraint solving
  15. algorithm. Kiwi is an implementation of the algorithm based on the
  16. `seminal Cassowary paper <https://constraints.cs.washington.edu/solvers/cassowary-tochi.pdf>`_.
  17. It is *not* a refactoring of the original C++ solver. Kiwi has been designed
  18. from the ground up to be lightweight and fast. Kiwi ranges from 10x to 500x
  19. faster than the original Cassowary solver with typical usecases gaining a 40x
  20. improvement. Memory savings are consistently > 5x.
  21. In addition to the C++ solver, Kiwi ships with hand-rolled Python bindings for
  22. Python 3.7+.