Added textual docs explaining string representation

CONTRIBUTING.md

@@ -1,13 +1,18 @@
-Element number thirteen IS called aluminium.
+Thanks for wanting to contribute! This list states a few rules which we think
+are important to keep in mind when adding/editing code.
 
-ALWAYS run `cargo test` before pushing to master (please)
 
-Every particle HAS TO implement the `Properties` trait.
-Every element HAS TO implement the `Element` trait.
-Every struct and enum HAS TO derive the `Debug` trait.
+Before pushing / merging to master:
+- ALWAYS run tests (Travis)
+- ALWAYS rebuild rust-docs (``./generate_docs.sh`)
+
+Every particle type HAS TO implement the `Properties` trait.
+Every element type HAS TO implement the `Element` trait.
 
 Types MUST NOT be explicitly stated unless necessary.
 
-`return` IS NOT necessary, but IS allowed.
+Files SHOULD stay under the ninety (90) character horizontal limit.
+
+Try to keep your code-style as close to the existing code as possible.
 
-Files SHOULD stay under the ninety-character horizontal limit.
+Element number eleven (11) is called aluminium.

Cargo.toml

@@ -1,20 +1,21 @@
 [package]
 name = "feroxide"
 version = "1.2.0"
-authors = ["feroxide"]
-build = "src/build.rs"
+authors = [ "feroxide" ]
 
 description = "A basic chemistry simulator"
-documentation = "https://feroxide.github.io/feroxide/docs/feroxide"
+documentation = "https://feroxide.github.io/feroxide/rust-docs/feroxide"
 homepage = "https://feroxide.github.io/feroxide/"
 repository = "https://github.com/feroxide/feroxide"
 
+keywords = [ "chemistry", "simulator", "mit" ]
+categories = [ "command-line-interface", "science" ]
+
 readme = "README.md"
+license-file = "LICENSE"
 
-keywords = ["chemistry", "simulator", "mit"]
-categories = ["command-line-interface", "science"]
+build = "src/build.rs"
 
-license-file = "LICENSE"
 
 [badges]
 travis-ci = { repository = "feroxide/feroxide", branch = "master" }

README.md

@@ -7,19 +7,17 @@ A basic chemistry simulator.
   * Calculate mass of molecules
   * Generate (sometimes still incorrect) names of molecules
   * Check if reactions are valid
-  * Get Atoms/Molecules/Ions/Reactions by inputting a string representation
-  * Get the Standard Electrode Potential for Redox reactions
+  * Get the Standard Electrode Potential for common Redox reactions
 
 - Advanced functionality
   * Create containers with molecules or ions in them
-  * Apply reactions to containers
-  * Redox reactions
+  * Apply (redox) reactions to containers
 
 ## GUI
 The GUI project can be found [here](https://github.com/feroxide/feroxide-gui).
 
 ## Rust docs
-The Rust docs can be found [here](./docs/feroxide/index.html).
+The Rust docs can be found [here](./rust-docs/feroxide/index.html).
 
 ## Contributing
 Please check the [CONTRIBUTING](./CONTRIBUTING.md) file first.

TODO.md

@@ -2,19 +2,14 @@
   - Reactions
     * Precipitation reactions
     * Acid/Base reactions
-
+  - Add hydration (ex. CuSO4.5H2O) to molecules
+  - Optimise common data
 
 - `atoms.rs`
   * Names for special cases (-oxide etc.)
 
 - `reaction.rs`
-  * Calculate the correct amount of Energy required
+  * Calculate the correct amount of energy required
 
 - `redox.rs`
   * Clean up `elem_reaction`
-
-- `data_atoms.toml`
-  * Complete list of atoms
-
-- `data_sep.rs`
-  * Complete list of SEP

clippy.sh

@@ -4,14 +4,15 @@ mode="$1"
 
 if [ "$TRAVIS_RUST_VERSION" = "nightly" ]; then
   if [ "$mode" = "install" ]; then
-    cargo install clippy
+    cargo install clippy --verbose
     exit $?
-  fi
-
-  if [ "$mode" = "test" ]; then
+  elif [ "$mode" = "test" ]; then
     cargo clippy --verbose -- -D warnings
     exit $?
+  else
+    echo "Mode not specified or unknown" >&2
+    exit 1
   fi
+else
+  exit 0
 fi
-
-exit 0