circule 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e4e4894325d1bf81df66128c33d88c322dd4e08d0faf0b6c18bdc2eed8ae2b
-  data.tar.gz: 650614530ad282450742196f3ca0d5a508ed7d596c45c0ec5c0f989ae507ec04
+  metadata.gz: 87915c12b5e6c349eb173949f59eda6e6fbd706ec7d4a9d44ea1fa1ba550714c
+  data.tar.gz: 92fbd34f5f934f96decb84a3b7e54568cfaef6e41f9f9988701ece62907c9fd9
 SHA512:
-  metadata.gz: 2ddb1e5028f38a1fef77c042c1dadda261b031959b5ef9949c6f37399dc321cf77b988df5b2fba4dc4b883e5e9aa02538d294915747ff9bcb5bf8122be0df31f
-  data.tar.gz: 47ce9b8709463319b71d2d6797ba2032cecd71bdfd149ed511f5097263e8d36e3799ef92be9a3011a48161bf6e3e659c71e28bfb6be70231196f5cef71aaa3e8
+  metadata.gz: 423863eceeeb72a2024b63be95c5e10975dd197fe887a98b3d79589b39c617c9ed891fa27bc37ffb41459dd75ad0e669d8ea40baf366b7cb954cabaa10f1adf0
+  data.tar.gz: d5b08d2b430c2b81533151139889245029bf233c4ea08015601e3587f016cc736ecd52804494e989c4da17ecc82e04274fb18d0c54cd97ab1660b9584e5e67e0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    circule (0.1.1)
+    circule (0.1.2)
       chunky_png
 
 GEM

data/README.md

@@ -1,11 +1,16 @@
 # Circule
 
-Welcome to your new gem! In this directory, you'll find the files you
-need to be able to package up your Ruby library into a gem. Put your
-Ruby code in the file `lib/circule`. To experiment with that code, run
-`bin/console` for an interactive prompt.
+Generate an icon of overlapping circles derived from a hash.
 
-TODO: Delete this and the text above, and describe your gem
+1. Slice the hash into 16-bit slices starting at bit `bn`, stepping `s`
+   bits at a time, ending after bit `bn`.
+
+2. From each slice define a circle such that bits 0 through 4 is the `x`
+   coordinate of the center, bits 5 through 9 is the `y` coordinate of
+   the center, and bits 10 through 15 is the radius of the circle.
+
+3. Each pixel in the output will be colored based on the number of
+   circles that point is inside.
 
 ## Installation
 
@@ -25,7 +30,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### CLI Options
+
+| Short Option | Long Option   | Description                      |
+|--------------|---------------|----------------------------------|
+| -h HEXSTRING | --hex         | Use this hash                    |
+| -b INTEGER   | --btc-block   | Use hash from this bitcoin block |
+| -0 INTEGER   | --bit0        | Starting bit                     |
+| -s INTEGER   | --step        | Step bit                         |
+| -n INTEGER   | --bitn        | Starting bit                     |
+| -c INTEGER   | --canvas      | Canvas size                      |
+| -x INTEGER   | --ox          | Offset x                         |
+| -y INTEGER   | --oy          | Offset y                         |
+| -z INTEGER   | --zoom        | Zoom in GUI                      |
+| -f FILENAME  | --file        | Use hash from file               |
+| -s FILENAME  | --save        | Save image to file               |
+| -g           | --gui         | Run GUI (requires glimmer & tk)  |
+| -i           | --interactive | Run GUI with pry                 |
 
 ## Development
 
@@ -41,7 +62,7 @@ push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
+Bug reports and pull requests are welcome on GitLab at
 https://gitlab.com/fjc/circule.
 
 ## License

data/circule.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Frank J. Cameron']
   spec.email         = ['fjc@fastmail.net']
 
-  spec.summary       = ''
+  spec.summary       = 'Generate an icon of overlapping circles derived from a hash.'
   spec.homepage      = 'https://gitlab.com/fjc/circule'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.7.0'

data/exe/circule

@@ -6,7 +6,7 @@ require 'optparse'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = ''
+  opts.banner = 'Generate an icon of overlapping circles derived from a hash.'
 
   opts.on('-h HEXSTRING', '--hex', 'Use this hash') do |h|
     options[:hex] = h

data/lib/circule/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Circule
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circule
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Frank J. Cameron
@@ -69,5 +69,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: ''
+summary: Generate an icon of overlapping circles derived from a hash.
 test_files: []