misc: Removed dead code in cbindgen.toml, added developer notes, tweaked some readme wording.

Author: amunra

DEV_NOTES.md

@@ -0,0 +1,32 @@
+# Developer notes
+
+## CMake Integration
+We temporarily use a forked version of https://github.com/corrosion-rs/corrosion
+to enable linking the Rust crate as C rather than C++.
+
+The "corrosion" directory has been added as:
+
+```
+git subtree add --prefix corrosion https://github.com/amunra/corrosion master --squash
+```
+
+and is being maintained as:
+
+```
+git subtree add --prefix corrosion https://github.com/amunra/corrosion master --squash
+```
+
+Until our outstanding pull request with the upstream project is resolved.
+See: https://github.com/corrosion-rs/corrosion/pull/188.
+
+
+## Building without CMake
+For development, you may also call `cargo build` directly.
+By default, this will not build the `C` FFI layer.
+
+For that, call `cargo build --features ffi`.
+
+If you are editing the C functions and what to see the resulting generated
+header file, call `cargo build --features cbindgen`.
+
+Note that to reduce compile time we don't use cbindgen in the header we ship.

README.md

@@ -37,8 +37,8 @@ To understand the protocol in more depth, consult the
 
 ## Using this Library
 
-Start with the [build instructions](BUILD.md), then read guide for including
-this library as a [dependency to your project](DEPENDENCY.md).
+Start with the [build instructions](BUILD.md), then read the guide for including
+this library as a [dependency from your project](DEPENDENCY.md).
 
 Once you've all set up, you can take a look at our examples:
 
@@ -79,7 +79,7 @@ See a [complete example in C++](examples/line_sender_cpp_example.cpp).
 The API is sequentially coupled, meaning that methods need to be called in a
 specific order.
 
-For each row you need to specify a table name and at least one symbol or
+For each row, you need to specify a table name and at least one symbol or
 column. Symbols must be specified before columns.
 Once you're done with a row you must add a timestamp calling `at` or `at_now`.
 
@@ -103,7 +103,7 @@ a failure.
 You may then call `line_sender_error_msg(err)` and
 `line_sender_error_get_code(err)` to extract error details.
 
-Once handled, the error object *must* be disposed by calling
+Once handled, the error object *must* be disposed of by calling
 `line_sender_error_free(err)`.
 
 On error you must also call `line_sender_close(sender)`.

cbindgen.toml

@@ -40,21 +40,12 @@ includes = []  # ["my_great_lib.h"]
 no_includes = true
 
 after_includes = """
-#if defined(LINESENDER_DYN_LIB)
-#    if defined(_MSC_VER)
-#        if defined(LINESENDER_EXPORTS)
-#            define LINESENDER_API __declspec(dllexport)
-#        else
-#            define LINESENDER_API __declspec(dllimport)
-#        endif
-#    elif (__GNUC__ >= 4)
-#        define LINESENDER_API __attribute__ ((visibility("default")))
-#    else
-#        error "Compiler unsupported or badly detected."
-#    endif
+#if defined(LINESENDER_DYN_LIB) && defined(_MSC_VER)
+#    define LINESENDER_API __declspec(dllimport)
 #else
 #    define LINESENDER_API
-#endif"""
+#endif
+"""
 
 # #ifdef __cplusplus
 # extern "C" {