Improve documentation and add tests

.github/workflows/ci.yml

@@ -21,9 +21,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@nightly
-        with:
-          components: llvm-tools, rustc-dev
+      - uses: dtolnay/rust-toolchain@stable
       - run: cargo test --all-features --release --tests
 
   clippy:
@@ -32,7 +30,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@nightly
+      - uses: dtolnay/rust-toolchain@stable
         with:
           components: clippy,rustc-dev
       - run: cargo clippy --all-features --tests --benches -- -Dclippy::all -Dclippy::pedantic
@@ -44,8 +42,7 @@ jobs:
       CARGO_TERM_COLOR: always
     steps:
       - uses: actions/checkout@v4
-      - name: Install Rust
-        run: rustup update stable
+      - uses: dtolnay/rust-toolchain@stable
       - name: Install cargo-llvm-cov
         uses: taiki-e/install-action@cargo-llvm-cov
       - name: Generate code coverage

README.md

@@ -1,11 +1,13 @@
 # Compass Data
 
-![GitHub branch status](https://img.shields.io/github/checks-status/zheylmun/compass_data/main?style=for-the-badge&logo=GitHub)
+[![Crates.io Version](https://img.shields.io/crates/v/compass_data?style=for-the-badge)](https://crates.io/crates/compass_data)
+[![docs.rs](https://img.shields.io/docsrs/compass_data?style=for-the-badge)](https://docs.rs/compass_data/latest/compass_data/)
+[![GitHub branch status](https://img.shields.io/github/checks-status/zheylmun/compass_data/main?style=for-the-badge&logo=GitHub)](https://github.com/zheylmun/compass_data/actions)
 [![Codecov](https://img.shields.io/codecov/c/github/zheylmun/compass_data?style=for-the-badge&logo=CodeCov)](https://app.codecov.io/gh/zheylmun/compass_data)
 
 Small library for loading, working with, and generating [Compass](https://www.fountainware.com/compass/index.htm) survey project and survey files. Please note that there are no plans to load plot files.
-The goal is to enable interop between survey software,
-not replace functionality.
+The goal is to enable inter-operation and data sharing between survey software.
+Data analysis and mapping making functionality are not current goals.
 
 ## License
 

src/lib.rs

@@ -22,7 +22,9 @@ mod tests {
         let mut sample_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
         sample_path.push("test_data/Fulfords.mak");
 
-        let loaded_project = Project::read(&sample_path).unwrap();
-        assert_eq!(loaded_project.survey_files.len(), 2);
+        let unloaded_project = Project::read(&sample_path).unwrap();
+        assert_eq!(unloaded_project.survey_files.len(), 2);
+        // Make sure we can load all the project files too
+        let _loaded_project = unloaded_project.load_survey_files().unwrap();
     }
 }

src/project/mod.rs

@@ -15,6 +15,7 @@ use std::{
 use crate::{EastNorthElevation, Error, Survey, UtmLocation};
 
 /// Compass projects can be defined in a variety of geodetic datums.
+///
 /// The datum is used to convert between the geodetic coordinates used in the survey data.
 /// This enum provides a list of the datums supported by Compass.
 #[derive(Clone, Copy, Debug, PartialEq)]