tools/corrosion/doc/src/introduction.md
branchtransitional_engine
changeset 16050 6a3dc15b78b9
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tools/corrosion/doc/src/introduction.md	Wed Aug 28 15:31:51 2024 +0200
@@ -0,0 +1,19 @@
+## About Corrosion
+
+Corrosion, formerly known as cmake-cargo, is a tool for integrating Rust into an existing CMake
+project. Corrosion is capable of automatically importing executables, static libraries, and
+dynamic libraries from a Rust package or workspace as CMake targets.
+
+The imported static and dynamic library types can be linked into C/C++ CMake targets using the usual
+CMake functions such as [`target_link_libraries()`].
+For rust executables and dynamic libraries corrosion provides a `corrosion_link_libraries`
+helper function to conveniently add the necessary flags to link C/C++ libraries into
+the rust target.
+
+You are currently viewing the documentation of the stable v0.5 release branch.
+
+[`target_link_libraries()`]: https://cmake.org/cmake/help/latest/command/target_link_libraries.html
+
+## Requirements
+
+Corrosion v0.5 requires at least CMake 3.15 and at least Rust 1.46 or newer.
\ No newline at end of file