more docs and added the import_config.h file to controlle which c++ libraries are added

Project/game/Cargo.toml

@@ -7,4 +7,5 @@ edition = "2021"
 crate-type = ["staticlib"]
 
 [dependencies]
+
 arduboy-rust = { path = "../../arduboy-rust" }

Project/game/src/lib.rs

@@ -1,6 +1,9 @@
 #![no_std]
 #![allow(non_upper_case_globals)]
 
+#[no_mangle]
+pub static ArduboyTones_Library: u8 = 1;
+
 //Include the Arduboy Library
 #[allow(unused_imports)]
 use arduboy_rust::prelude::*;

Wrapper-Project/src/main.h

@@ -1,16 +1,6 @@
 #pragma once
 
-// Comment out the librarys you dont need.
+#include "../../import_config.h"
-// This saves memory but be carful if the librarys are not defined
-// it will not export the given functions for the rust project.
-//
-// to save a good amount you can comment out
-// the ArduboyTones library if you don't need it.
-
-#define Arduboy2_Library ;
-#define ArduboyTones_Library ;
-#define EEPROM_Library ;
-#define Arduino_Library ;
 
 #if defined(Arduboy2_Library)
 #include <Arduboy2.h>

arduboy-rust/src/lib.rs

@@ -8,11 +8,20 @@
 //! ```
 //! use arduboy_rust::prelude::*;
 //! ```
-//! Inside the Wrapper-Project folder is a folder named src.
+//! ### Disable C++ libraries
-//! You can disable C++ libraries in the main.h file.
+//! Inside the root directory is a file named `import_config.h`
+//!
+//! You can disable C++ libraries in the `import_config.h` file.
 //! Just comment the unused library definition out.
 //!
-//! To get an idea, the ArduboyTones Library needs 2-3% of the flash memory.
+//! Be careful with disabling libraries because:
+//! - The only error you get is something like this if you try to use a function that relies on the library you disabled.
+//! ```text
+//! game.90c69b91e57f285-cgu.0:(.text.loop+0x290): undefined reference to `sound_tone'
+//! ```
+//! - the benefit of disabling will be important in the feature when I add support for the ArduboyG library etc.
+//!
+//! To get an idea, the ArduboyTones Library needs additional 2-3% of the flash memory.
 //!
 //! [Here is the link to the GitHub Repo](https://github.com/zenndev1337/rust-for-arduboy)
 

docs/doc/src/arduboy_rust/lib.rs.html

@@ -25,6 +25,15 @@
 <a href="#25" id="25">25</a>
 <a href="#26" id="26">26</a>
 <a href="#27" id="27">27</a>
+<a href="#28" id="28">28</a>
+<a href="#29" id="29">29</a>
+<a href="#30" id="30">30</a>
+<a href="#31" id="31">31</a>
+<a href="#32" id="32">32</a>
+<a href="#33" id="33">33</a>
+<a href="#34" id="34">34</a>
+<a href="#35" id="35">35</a>
+<a href="#36" id="36">36</a>
 </pre></div><pre class="rust"><code><span class="attr">#![cfg(target_arch = <span class="string">&quot;avr&quot;</span>)]
 #![no_std]
 #![feature(c_size_t)]
@@ -35,11 +44,20 @@
 //! ```
 //! use arduboy_rust::prelude::*;
 //! ```
-//! Inside the Wrapper-Project folder is a folder named src.
+//! ### Disable C++ libraries
-//! You can disable C++ libraries in the main.h file.
+//! Inside the root directory is a file named `import_config.h`
+//!
+//! You can disable C++ libraries in the `import_config.h` file.
 //! Just comment the unused library definition out.
 //!
-//! To get an idea, the ArduboyTones Library needs 2-3% of the flash memory.
+//! Be careful with disabling libraries because:
+//! - The only error you get is something like this if you try to use a function that relies on the library you disabled.
+//! ```text
+//! game.90c69b91e57f285-cgu.0:(.text.loop+0x290): undefined reference to `sound_tone&#39;
+//! ```
+//! - the benefit of disabling will be important in the feature when I add support for the ArduboyG library etc.
+//!
+//! To get an idea, the ArduboyTones Library needs additional 2-3% of the flash memory.
 //!
 //! [Here is the link to the GitHub Repo](https://github.com/zenndev1337/rust-for-arduboy)
 

import_config.h

@@ -0,0 +1,21 @@
+#pragma once
+
+// #################
+// #    WARNING    #
+// #################
+//
+// ## Read the docs before change here things!! ##
+//
+// https://zenndev1337.github.io/Rust-for-Arduboy/
+//
+// Comment out the librarys you dont need.
+// This saves memory but be carful if the librarys are not defined
+// it will not export the given functions for the rust project.
+//
+// to save a good amount you can comment out
+// the ArduboyTones library if you don't need it.
+
+#define Arduboy2_Library ;
+#define ArduboyTones_Library ;
+#define EEPROM_Library ;
+#define Arduino_Library ;