You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

22 lines
1.3 KiB

3 months ago
  1. CArL {#mainpage}
  2. ============
  3. This is the documentation of CArL, an Open Source C++ Library for Computer Arithmetic and Logic.
  4. On this page, you can find introductory information on how to obtain and compile CArL, discussion of some core features of CArL as well as traditional doxygen API documentation.
  5. If you are new to CArL and want to have a look around, we recommend reading the @ref userdoc.
  6. This section gives a gentle introduction to basic concepts like number types, polynomials and alike.
  7. If you want to use CArL and want to know how to get and install it, have a look at @ref getting_started.
  8. It covers the most important steps including obtaining the actual source code, obtaining dependencies, building the library and running our test suite.
  9. If you already use CArL and want to dig deeper or submit new code, you can read the @ref devguide.
  10. It contains information about supplementary features like our logging framework and some basic guidelines for our code like how we use doxygen.
  11. Note that this documentation is, and will probably still be for quite some time, work in progress.
  12. If you feel that some topic that is important to you is missing or some explanation is unclear, please let us know!
  13. ### Contact
  14. - github: https://github.com/smtrat/carl
  15. - IRC: \#carl on chat.freenode.net