mirror of
https://github.com/usetrmnl/sensor_scanner.git
synced 2026-04-29 13:45:14 -07:00
Brooke Kuhlmann
80ff29343a
Necessary to provide initial scaffolding for this project. This was generated using link:https://alchemists.io/projects/rubysmith[Rubysmith]. While this isn't a Ruby project since the core implementation is in C, having the Ruby tooling will help from a CI and code quality perspective.
:toc: macro
:toclevels: 5
:figure-caption!:
= Sensor Scanner
toc::[]
== Features
== Requirements
. link:https://www.ruby-lang.org[Ruby].
== Setup
To set up project, run:
[source,bash]
----
git clone https://github.com/bkuhlmann/sensor_scanner
cd sensor_scanner
bin/setup
----
== Usage
== Development
To contribute, run:
[source,bash]
----
git clone https://github.com/usetrmnl/sensor_scanner
cd sensor_scanner
bin/setup
----
You can also use the IRB console for direct access to all objects:
[source,bash]
----
bin/console
----
== Tests
To test, run:
[source,bash]
----
bin/rake
----
== Credits
* Built with link:https://alchemists.io/projects/rubysmith[Rubysmith].
* Engineered by {trmnl_link}.