boxbot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a637cc4c6c5fe2f4350331e0e1b3d57ca9d5f16283ffaf36848180010d79496
-  data.tar.gz: aac8f54a6c7b8e14d2e9cfcc3ed82d57fad42556b4809404a223ce7de13b3fb9
+  metadata.gz: 650088d890b68b42d7895d9c75be3ead5545823d1edd32cb4f1198825da8bb7e
+  data.tar.gz: 151dcb6af91f05223ec766fcf6819a8503fc80d1a59f20e1f019ca90914a519b
 SHA512:
-  metadata.gz: 9855b84986a678cf9a22e5f7ce5a1a06cbca94a6d3acaf1d07730b359adad7797e10b67fd36482f5ed1215e433d1e5aa1af0fe47c74a20fa1c7c00d1bbdd865d
-  data.tar.gz: f67e9dbb4c301523efd2051b79f7eee3bf551602d7d23498a62cef29668792ac9be62817bcacf151f6475eb4b203cac1f884c4bff1f148c4bb8d2b6ae783b128
+  metadata.gz: 3cfddfa69f123b3bc6f57311e0590f853454e050a1333d657d1bd217112e419c6c9312148d743858b7555733dc9987b3bd56d9a2e68376c9085caa7fbd6ebc0c
+  data.tar.gz: 4c9223fb039e7a4f0aa62a459bf345281a28744508dd9ee66f40dc4838f9649e2a56122b385d19388d712c0ccf8ed4dc7ec4e2960d26882ac790bfc32a1b0984

data/.gitignore

@@ -1,3 +1,4 @@
+**/.DS_Store
 /.bundle/
 /.yardoc
 /_yardoc/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxbot (0.1.0)
+    boxbot (0.1.1)
       dry-configurable
       dry-monads
       dry-struct

data/README.md

@@ -4,9 +4,21 @@
 
 # Boxbot
 
-**Work In Progress**
+> NOTE: **This gem is not yet finished, and is work in progress.**
 
-This is a rewrite of the [laser-cutter](https://github.com/kigster/laser-cutter) box drawing logic.
+BoxBot aims to generate an SVG or PDF template that is meant to be used with a laser cutter. Boxbot will generate a 2D cut layout for a 3D box (parallelepiped) with matching tabs that allow the box to be "snapped into place" without screws, although screws and T-joins can also be added. This gem is currently work in progress, and is a rewrite of the [laser-cutter](https://github.com/kigster/laser-cutter) box drawing logic.
+
+## Layouts
+
+The following is an example layout of the box that's 5x4x3 (width, height, depth):
+
+![layout](img/layout.png)
+
+## Kerf
+
+Kerf is the width of the laser-cutting beam. The following diagram depicts how Boxbot generates templates with the non-zero Kerf defined. The yellow line below is where the laser cuts, the red/black are the areas of the material removed by the laser cutter. The light blue is the "desired" shape of the tabs.
+
+![layout](img/kerf.png)
 
 ## Installation
 

data/boxbot.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'boxbot/version'
@@ -9,11 +8,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Konstantin Gredeskoul']
   spec.email         = ['kigster@gmail.com']
 
-  spec.summary       = 'Boxbot - is a work in progress replacement of the laser-cutter ruby gem'
-  spec.description   = 'Boxbot - is a work in progress replacement of the laser-cutter ruby gem'
+  BOXBOT__SUMMARY    = 'BoxBot aims to generate an SVG or PDF template that is meant to be used with a laser cutter. Boxbot will generate a 2D cut layout for a 3D box (parallelepiped) with matching tabs that allow the box to be "snapped into place" without screws, although screws and T-joins can also be added. This gem is currently work in progress, and is a rewrite of the laser-cutter box drawing logic.'
+
+  spec.summary       = BOXBOT__SUMMARY
+  spec.description   = BOXBOT__SUMMARY
   spec.homepage      = 'https://github.com/kigster/boxbot'
   spec.license       = 'MIT'
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

data/lib/boxbot/version.rb

@@ -1,3 +1,3 @@
 module Boxbot
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -206,7 +206,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Boxbot - is a work in progress replacement of the laser-cutter ruby gem
+description: BoxBot aims to generate an SVG or PDF template that is meant to be used
+  with a laser cutter. Boxbot will generate a 2D cut layout for a 3D box (parallelepiped)
+  with matching tabs that allow the box to be "snapped into place" without screws,
+  although screws and T-joins can also be added. This gem is currently work in progress,
+  and is a rewrite of the laser-cutter box drawing logic.
 email:
 - kigster@gmail.com
 executables: []
@@ -224,6 +228,9 @@ files:
 - bin/console
 - bin/setup
 - boxbot.gemspec
+- img/kerf.png
+- img/layout.png
+- img/sides.png
 - lib/boxbot.rb
 - lib/boxbot/compute/tab_calculator.rb
 - lib/boxbot/dimensions.rb
@@ -253,5 +260,9 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Boxbot - is a work in progress replacement of the laser-cutter ruby gem
+summary: BoxBot aims to generate an SVG or PDF template that is meant to be used with
+  a laser cutter. Boxbot will generate a 2D cut layout for a 3D box (parallelepiped)
+  with matching tabs that allow the box to be "snapped into place" without screws,
+  although screws and T-joins can also be added. This gem is currently work in progress,
+  and is a rewrite of the laser-cutter box drawing logic.
 test_files: []