Skip to content

Commit

Permalink
Initial information
Browse files Browse the repository at this point in the history
  • Loading branch information
the-Jamz authored May 25, 2020
1 parent 689cdf6 commit 833da44
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
# Huhnitor
Intergalactic serial monitor

# Binaries
All pre-compiled binaries can be located <a href="https://github.com/SpacehuhnTech/Huhnitor/releases">here.</a>

# Compiling
Compiling requires you to install <a href="https://www.rust-lang.org/tools/install">rustup</a>.
Clone the repository, cd into the root, and run the command `cargo build --release`, your binary will be located in `target/release`. This process should work on Windows, Mac, and Linux.

# Usage
This serial monitor is designed around being as easy to use as possible, just running the executable, then plugging the device you wish to communicate with when promoted should allow for auto-detection of the correct serial port. If this does not work, or you don't want to use this method for some other reason, specifying `-s` will display the serial ports viewed by the system, then allow you to type in any port path you like.

## Credits
Written by <a href="https://github.com/the-Jamz">Jamz</a> with help from <a href="https://selic.re/">Selicre</a>.

## License
This software is licensed under the MIT License. See the [license file](LICENSE) for details.

0 comments on commit 833da44

Please sign in to comment.