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.

53 lines
2.1 KiB

2 months ago
  1. Getting Started {#getting_started}
  2. =======
  3. Download
  4. --------
  5. We mirror our master branch to github.com. If you want to use the newest bleeding edge version, you can checkout from https://github.com/smtrat/carl.
  6. Although we try to keep the master branch stable, there is a chance that the current revision is broken.
  7. You can check [here](https://travis-ci.org/smtrat/carl/builds) if the current revision compiles and all the unit tests work.
  8. We regularly tag reasonably stable versions. You can find them at https://github.com/smtrat/carl/releases.
  9. Quick installation guide
  10. --------------------------------------------
  11. - Make sure all @subpage dependencies "dependencies" are available.
  12. - Download the latest release or clone the git repository from https://github.com/smtrat/carl.
  13. - Prepare the build.
  14. @code{.sh}
  15. $ mkdir build && cd build && cmake ../
  16. @endcode
  17. - Build carl (with tests and documentation).
  18. @code{.sh}
  19. $ make
  20. $ make test doc
  21. @endcode
  22. Sample installations:
  23. - @subpage ubuntu_1404_lts
  24. - @subpage windows_7_msvc2014
  25. Using CArL
  26. --------------------------------------------
  27. CArL registers itself in the CMake system, hence to include CArL in any other CMake project, just use `find_package(carl)`.
  28. To use CArL in other projects, link against the shared or static library created in `build/`.
  29. Supported platforms
  30. --------------------------------------------
  31. We have tested carl successfully on the following platforms:
  32. - Arch Linux with Clang 3.9.1 and GCC 6.2.1
  33. - Ubuntu 14.04 LTS with several compilers on [Travis CI](https://travis-ci.org/smtrat/carl)
  34. - OS X 10.11 with several compilers on [Travis CI](https://travis-ci.org/smtrat/carl)
  35. We usually support at least all `clang` and `gcc` versions starting from those shipped with the latest Ubuntu LTS or Debian stable releases.
  36. As of now, this is `clang-3.8` and newer and `gcc-5` and newer.
  37. Advanced building topics
  38. --------------------------------------------
  39. - @subpage build_cmake
  40. Troubleshooting
  41. --------------------------------------------
  42. If you're experiencing problems, take a look at our @subpage troubleshooting section. If that doesn't help you, feel free to contact us.