Sha256: b0d22a03bc3bf312d2ccbfc248872996c7379ee46afca3291e8593ee25eab641
Contents?: true
Size: 1.63 KB
Versions: 3
Compression:
Stored size: 1.63 KB
Contents
# <%= config[:name_as_class] %> Spike
This is the auto-generated README for the <%= config[:name_as_class] %> spike. This content was generated by the [Spiker](https://github.com/norlinga/spiker) gem.
## Getting Started
This directory is the result of **someone** running the following command on a command line:
$ gem install spiker
$ spiker multi <%= config[:name] %>
$ cd <%= config[:name] %>
Once inside the spike directory, open your favorite text editor and then execute the following command:
$ bundle install
$ guard
Bundler will have executed once when the spike directory was first created, but it's no problem to run it again (in case the spike directory was shared between machines / environments).
After starting Guard you should have been greeted with passing tests. You are now ready to start hashing out your spike under test.
## Adding to This README
This README could be a great place to capture findings from your spike. Topics to address in this README might include:
- what was the initial motivation for this spike?
- what is the current state of this spike?
- is there a future intention or unrealized goal for this spike?
- what was discovered in the course of this spike?
- who is involved in this spike?
## Feel Free to Include Code
Embedding code in a Markdown file is easy - this README uses the triple backtick syntax. The following code will be rendered as a Ruby code block:
```ruby
require 'dotenv'
puts ENV["TEST_VALUE"]
"maybe show some code in your README?".capitalize
```
Spikes are intended to be short lived, but that's no reason to skip proper practices in your spike development. Have fun!
Version data entries
3 entries across 3 versions & 1 rubygems