tools/corrosion/doc/src/introduction.md
branchtransitional_engine
changeset 16021 6a3dc15b78b9
equal deleted inserted replaced
16009:7544a7d7c819 16021:6a3dc15b78b9
       
     1 ## About Corrosion
       
     2 
       
     3 Corrosion, formerly known as cmake-cargo, is a tool for integrating Rust into an existing CMake
       
     4 project. Corrosion is capable of automatically importing executables, static libraries, and
       
     5 dynamic libraries from a Rust package or workspace as CMake targets.
       
     6 
       
     7 The imported static and dynamic library types can be linked into C/C++ CMake targets using the usual
       
     8 CMake functions such as [`target_link_libraries()`].
       
     9 For rust executables and dynamic libraries corrosion provides a `corrosion_link_libraries`
       
    10 helper function to conveniently add the necessary flags to link C/C++ libraries into
       
    11 the rust target.
       
    12 
       
    13 You are currently viewing the documentation of the stable v0.5 release branch.
       
    14 
       
    15 [`target_link_libraries()`]: https://cmake.org/cmake/help/latest/command/target_link_libraries.html
       
    16 
       
    17 ## Requirements
       
    18 
       
    19 Corrosion v0.5 requires at least CMake 3.15 and at least Rust 1.46 or newer.