guard-openscad 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. data/Gemfile +1 -1
  2. data/README.md +45 -0
  3. data/VERSION +1 -1
  4. data/guard-openscad.gemspec +6 -6
  5. metadata +6 -6
  6. data/README.rdoc +0 -19
data/Gemfile CHANGED
@@ -5,7 +5,7 @@ gem "guard", "~> 1.6"
5
5
 
6
6
  gem "rb-fsevent", "~> 0.9"
7
7
 
8
- gem "scad4r", "~> 0.2.1"
8
+ gem "scad4r", "~> 0.3"
9
9
 
10
10
  group :development do
11
11
  gem "aruba", "~> 0.5"
@@ -0,0 +1,45 @@
1
+ guard-openscad -- A Guard plugin for OpenSCAD
2
+ =============================================
3
+
4
+ ## DESCRIPTION
5
+
6
+ guard-openscad provides a Guardfile configuration interface for running .scad files through OpenSCAD as you change them. This is helpful if you:
7
+
8
+ * Prefer editing outside of OpenSCAD and want some syntax checking
9
+ * Want to automatically output STL files for quickly slicing
10
+
11
+
12
+ ## INSTALLATION
13
+
14
+ The preferred way of installing guard-openscad is through bundler. Out of the box, it provides you reasonable defaults for at least quickly checking syntax.
15
+
16
+ 1. Add guard-openscad to your Gemfile in a directory for your new thing.
17
+
18
+ gem "guard-openscad"
19
+
20
+ 1. Run `bundle install` to install guard-openscad and all its dependencies.
21
+ 1. Setup your Guardfile with `bundle exec guard init`. This will provide you a default Guardfile configured to watch for changes to .scad files in a subdirectory called scad.
22
+ 1. Run guard with `bundle exec guard`
23
+
24
+ ## USAGE
25
+
26
+ Now, with guard running, try creating a new scad file, `scad/cube.scad`
27
+
28
+ cube(10,10,10);
29
+
30
+ When you save it, guard observes the change, and runs it through openscad! You'll get a notification showing you everything is OK and a .csg version of the file.
31
+
32
+ ## Contributing to guard-openscad
33
+
34
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
35
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
36
+ * Fork the project.
37
+ * Start a feature/bugfix branch.
38
+ * Commit and push until you are happy with your contribution.
39
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
40
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
41
+
42
+ ## Copyright
43
+
44
+ Copyright (c) 2013 Caleb Buxton. See LICENSE.txt for
45
+ further details.
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.1.3
1
+ 0.1.4
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = "guard-openscad"
8
- s.version = "0.1.3"
8
+ s.version = "0.1.4"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Caleb Buxton"]
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
14
14
  s.email = "me@cpb.ca"
15
15
  s.extra_rdoc_files = [
16
16
  "LICENSE.txt",
17
- "README.rdoc"
17
+ "README.md"
18
18
  ]
19
19
  s.files = [
20
20
  ".document",
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
23
23
  "Gemfile",
24
24
  "Guardfile",
25
25
  "LICENSE.txt",
26
- "README.rdoc",
26
+ "README.md",
27
27
  "Rakefile",
28
28
  "VERSION",
29
29
  "features/README.feature",
@@ -53,7 +53,7 @@ Gem::Specification.new do |s|
53
53
  s.add_runtime_dependency(%q<growl>, ["~> 1.0"])
54
54
  s.add_runtime_dependency(%q<guard>, ["~> 1.6"])
55
55
  s.add_runtime_dependency(%q<rb-fsevent>, ["~> 0.9"])
56
- s.add_runtime_dependency(%q<scad4r>, ["~> 0.2.1"])
56
+ s.add_runtime_dependency(%q<scad4r>, ["~> 0.3"])
57
57
  s.add_development_dependency(%q<aruba>, ["~> 0.5"])
58
58
  s.add_development_dependency(%q<cucumber>, ["~> 1.2"])
59
59
  s.add_development_dependency(%q<guard-cucumber>, ["~> 1.3"])
@@ -67,7 +67,7 @@ Gem::Specification.new do |s|
67
67
  s.add_dependency(%q<growl>, ["~> 1.0"])
68
68
  s.add_dependency(%q<guard>, ["~> 1.6"])
69
69
  s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
70
- s.add_dependency(%q<scad4r>, ["~> 0.2.1"])
70
+ s.add_dependency(%q<scad4r>, ["~> 0.3"])
71
71
  s.add_dependency(%q<aruba>, ["~> 0.5"])
72
72
  s.add_dependency(%q<cucumber>, ["~> 1.2"])
73
73
  s.add_dependency(%q<guard-cucumber>, ["~> 1.3"])
@@ -82,7 +82,7 @@ Gem::Specification.new do |s|
82
82
  s.add_dependency(%q<growl>, ["~> 1.0"])
83
83
  s.add_dependency(%q<guard>, ["~> 1.6"])
84
84
  s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
85
- s.add_dependency(%q<scad4r>, ["~> 0.2.1"])
85
+ s.add_dependency(%q<scad4r>, ["~> 0.3"])
86
86
  s.add_dependency(%q<aruba>, ["~> 0.5"])
87
87
  s.add_dependency(%q<cucumber>, ["~> 1.2"])
88
88
  s.add_dependency(%q<guard-cucumber>, ["~> 1.3"])
metadata CHANGED
@@ -2,7 +2,7 @@
2
2
  name: guard-openscad
3
3
  version: !ruby/object:Gem::Version
4
4
  prerelease:
5
- version: 0.1.3
5
+ version: 0.1.4
6
6
  platform: ruby
7
7
  authors:
8
8
  - Caleb Buxton
@@ -66,7 +66,7 @@ dependencies:
66
66
  requirements:
67
67
  - - ~>
68
68
  - !ruby/object:Gem::Version
69
- version: 0.2.1
69
+ version: '0.3'
70
70
  name: scad4r
71
71
  prerelease: false
72
72
  requirement: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
74
74
  requirements:
75
75
  - - ~>
76
76
  - !ruby/object:Gem::Version
77
- version: 0.2.1
77
+ version: '0.3'
78
78
  - !ruby/object:Gem::Dependency
79
79
  type: :development
80
80
  version_requirements: !ruby/object:Gem::Requirement
@@ -225,7 +225,7 @@ executables: []
225
225
  extensions: []
226
226
  extra_rdoc_files:
227
227
  - LICENSE.txt
228
- - README.rdoc
228
+ - README.md
229
229
  files:
230
230
  - .document
231
231
  - .rspec
@@ -233,7 +233,7 @@ files:
233
233
  - Gemfile
234
234
  - Guardfile
235
235
  - LICENSE.txt
236
- - README.rdoc
236
+ - README.md
237
237
  - Rakefile
238
238
  - VERSION
239
239
  - features/README.feature
@@ -263,7 +263,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
263
263
  - !ruby/object:Gem::Version
264
264
  segments:
265
265
  - 0
266
- hash: 418293515392501118
266
+ hash: -364868420290637596
267
267
  version: '0'
268
268
  required_rubygems_version: !ruby/object:Gem::Requirement
269
269
  none: false
@@ -1,19 +0,0 @@
1
- = guard-openscad
2
-
3
- Description goes here.
4
-
5
- == Contributing to guard-openscad
6
-
7
- * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
8
- * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
9
- * Fork the project.
10
- * Start a feature/bugfix branch.
11
- * Commit and push until you are happy with your contribution.
12
- * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
13
- * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
14
-
15
- == Copyright
16
-
17
- Copyright (c) 2013 Caleb Buxton. See LICENSE.txt for
18
- further details.
19
-