wip 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +8 -0
- data/README.mkd +87 -0
- data/Rakefile +3 -0
- data/doc/README.md +87 -0
- data/doc/TEMPLATE.md +26 -0
- data/lib/wip/version.rb +3 -0
- data/lib/wip.rb +3 -0
- data/wip.gemspec +26 -0
- metadata +92 -0
data/.gitignore
ADDED
data/README.mkd
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
`wip`
|
2
|
+
============================================================================
|
3
|
+
|
4
|
+
> NOTE: **`wip`** is WIP
|
5
|
+
|
6
|
+
**`wip`** is a concept I'm playing with for streamlining the process of
|
7
|
+
coding for and documenting client and personal software projects.
|
8
|
+
|
9
|
+
While this document (specifically) and the idea (generally) are
|
10
|
+
"work-in-progress", I've got a good sense of where I want to go with this
|
11
|
+
and will, in fact, be using the techniques described herein for this project
|
12
|
+
itself.
|
13
|
+
|
14
|
+
|
15
|
+
What is a **wip** Project
|
16
|
+
----------------------------------------------------------------------------
|
17
|
+
|
18
|
+
A Project is made up of:
|
19
|
+
|
20
|
+
* Notes
|
21
|
+
* Code
|
22
|
+
|
23
|
+
The goal is to create an experience in which working on a given client or
|
24
|
+
personal project is:
|
25
|
+
|
26
|
+
* easy to initialize
|
27
|
+
* easy to customize per the project needs
|
28
|
+
* has notes which are (optionally) maintained outside of the project's
|
29
|
+
codebase, yet are:
|
30
|
+
* version-controlled
|
31
|
+
* easily accessible from multiple desktops, web browsers, and mobile
|
32
|
+
devices
|
33
|
+
* authored in such a way as to be sensible in those environments
|
34
|
+
* has a workspace which is easily customizable to the needs of the
|
35
|
+
specific project in question and in which:
|
36
|
+
* work-in-progress changes are automatically version-controlled,
|
37
|
+
allowing for the tracking (and recovery of) any effort made, while
|
38
|
+
leaving it up to the developer(s) to determine when there is a
|
39
|
+
meaningful chunk of effort to commit the the project "proper".
|
40
|
+
* exportable/shareable... the project's setup may be shared with the
|
41
|
+
team-at-large, while allowing for "local" preferences as well.
|
42
|
+
|
43
|
+
|
44
|
+
Assumptions & Intentional Limitations
|
45
|
+
----------------------------------------------------------------------------
|
46
|
+
|
47
|
+
1. I develop with:
|
48
|
+
* an Apple computer
|
49
|
+
* an iPhone
|
50
|
+
* a :)
|
51
|
+
2. I strongly prefer TextMate to RubyMine (etc.), so no effort has been
|
52
|
+
made to adjust these concepts and tools for other editors/IDEs.
|
53
|
+
3. I hope to never again have to use CVS, Perforce, SourceSafe, ClearCase,
|
54
|
+
SVN (in chronological order of my use) etc. over Git. So, as with
|
55
|
+
editor-specific points, these recommendations assume the use of Git as
|
56
|
+
the version control tool in place.
|
57
|
+
|
58
|
+
|
59
|
+
On "Notes"
|
60
|
+
----------------------------------------------------------------------------
|
61
|
+
|
62
|
+
TODO: expand upon, clarify:
|
63
|
+
|
64
|
+
* backed by DropBox
|
65
|
+
* on-the-fly versioned, with git-wip
|
66
|
+
* in Markdown syntax
|
67
|
+
* authored to be viewable/editable within Textforce on the iPhone
|
68
|
+
|
69
|
+
|
70
|
+
On "Code"
|
71
|
+
----------------------------------------------------------------------------
|
72
|
+
|
73
|
+
TODO
|
74
|
+
|
75
|
+
|
76
|
+
Scratch Pad
|
77
|
+
----------------------------------------------------------------------------
|
78
|
+
|
79
|
+
* Here is an edit of this file, as navigated to within the git project.
|
80
|
+
Note that the `README` at the project's root is a symlink to this file.
|
81
|
+
As such, **DO NOT** edit that file (which Textmate allows).
|
82
|
+
* Here is an edit of this file, as navigated to through the Dropbox path
|
83
|
+
(which symlinks to the `doc` folder).
|
84
|
+
* Here is an edit of this file, as loaded in Textforce on my iPhone and
|
85
|
+
auto-sync'd back to my MacBook by way of Dropbox.
|
86
|
+
|
87
|
+
|
data/Rakefile
ADDED
data/doc/README.md
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
`wip`
|
2
|
+
============================================================================
|
3
|
+
|
4
|
+
> NOTE: **`wip`** is WIP
|
5
|
+
|
6
|
+
**`wip`** is a concept I'm playing with for streamlining the process of
|
7
|
+
coding for and documenting client and personal software projects.
|
8
|
+
|
9
|
+
While this document (specifically) and the idea (generally) are
|
10
|
+
"work-in-progress", I've got a good sense of where I want to go with this
|
11
|
+
and will, in fact, be using the techniques described herein for this project
|
12
|
+
itself.
|
13
|
+
|
14
|
+
|
15
|
+
What is a **wip** Project
|
16
|
+
----------------------------------------------------------------------------
|
17
|
+
|
18
|
+
A Project is made up of:
|
19
|
+
|
20
|
+
* Notes
|
21
|
+
* Code
|
22
|
+
|
23
|
+
The goal is to create an experience in which working on a given client or
|
24
|
+
personal project is:
|
25
|
+
|
26
|
+
* easy to initialize
|
27
|
+
* easy to customize per the project needs
|
28
|
+
* has notes which are (optionally) maintained outside of the project's
|
29
|
+
codebase, yet are:
|
30
|
+
* version-controlled
|
31
|
+
* easily accessible from multiple desktops, web browsers, and mobile
|
32
|
+
devices
|
33
|
+
* authored in such a way as to be sensible in those environments
|
34
|
+
* has a workspace which is easily customizable to the needs of the
|
35
|
+
specific project in question and in which:
|
36
|
+
* work-in-progress changes are automatically version-controlled,
|
37
|
+
allowing for the tracking (and recovery of) any effort made, while
|
38
|
+
leaving it up to the developer(s) to determine when there is a
|
39
|
+
meaningful chunk of effort to commit the the project "proper".
|
40
|
+
* exportable/shareable... the project's setup may be shared with the
|
41
|
+
team-at-large, while allowing for "local" preferences as well.
|
42
|
+
|
43
|
+
|
44
|
+
Assumptions & Intentional Limitations
|
45
|
+
----------------------------------------------------------------------------
|
46
|
+
|
47
|
+
1. I develop with:
|
48
|
+
* an Apple computer
|
49
|
+
* an iPhone
|
50
|
+
* a :)
|
51
|
+
2. I strongly prefer TextMate to RubyMine (etc.), so no effort has been
|
52
|
+
made to adjust these concepts and tools for other editors/IDEs.
|
53
|
+
3. I hope to never again have to use CVS, Perforce, SourceSafe, ClearCase,
|
54
|
+
SVN (in chronological order of my use) etc. over Git. So, as with
|
55
|
+
editor-specific points, these recommendations assume the use of Git as
|
56
|
+
the version control tool in place.
|
57
|
+
|
58
|
+
|
59
|
+
On "Notes"
|
60
|
+
----------------------------------------------------------------------------
|
61
|
+
|
62
|
+
TODO: expand upon, clarify:
|
63
|
+
|
64
|
+
* backed by DropBox
|
65
|
+
* on-the-fly versioned, with git-wip
|
66
|
+
* in Markdown syntax
|
67
|
+
* authored to be viewable/editable within Textforce on the iPhone
|
68
|
+
|
69
|
+
|
70
|
+
On "Code"
|
71
|
+
----------------------------------------------------------------------------
|
72
|
+
|
73
|
+
TODO
|
74
|
+
|
75
|
+
|
76
|
+
Scratch Pad
|
77
|
+
----------------------------------------------------------------------------
|
78
|
+
|
79
|
+
* Here is an edit of this file, as navigated to within the git project.
|
80
|
+
Note that the `README` at the project's root is a symlink to this file.
|
81
|
+
As such, **DO NOT** edit that file (which Textmate allows).
|
82
|
+
* Here is an edit of this file, as navigated to through the Dropbox path
|
83
|
+
(which symlinks to the `doc` folder).
|
84
|
+
* Here is an edit of this file, as loaded in Textforce on my iPhone and
|
85
|
+
auto-sync'd back to my MacBook by way of Dropbox.
|
86
|
+
|
87
|
+
|
data/doc/TEMPLATE.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
Note Heading
|
2
|
+
============================================================================
|
3
|
+
|
4
|
+
Introductory text.
|
5
|
+
|
6
|
+
|
7
|
+
Section Heading
|
8
|
+
----------------------------------------------------------------------------
|
9
|
+
|
10
|
+
Section text
|
11
|
+
|
12
|
+
|
13
|
+
Section Heading
|
14
|
+
----------------------------------------------------------------------------
|
15
|
+
|
16
|
+
With a list:
|
17
|
+
|
18
|
+
* item one
|
19
|
+
* item two, which
|
20
|
+
wraps
|
21
|
+
|
22
|
+
With code:
|
23
|
+
|
24
|
+
#!/bin/bash
|
25
|
+
echo "example code"
|
26
|
+
|
data/lib/wip/version.rb
ADDED
data/lib/wip.rb
ADDED
data/wip.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib/', __FILE__)
|
3
|
+
$:.unshift lib unless $:.include?(lib)
|
4
|
+
|
5
|
+
require 'wip/version'
|
6
|
+
|
7
|
+
Gem::Specification.new do |s|
|
8
|
+
s.required_rubygems_version = "> 1.3.6"
|
9
|
+
|
10
|
+
s.name ="wip"
|
11
|
+
s.version = WIP::VERSION
|
12
|
+
s.platform = Gem::Platform::RUBY
|
13
|
+
s.authors = ["Corey Innis"]
|
14
|
+
s.email = ["support+wip@coolerator.net"]
|
15
|
+
s.homepage = "http://github.com/coreyti/wip"
|
16
|
+
s.summary = "'wip': streamlined work-in-progress projects"
|
17
|
+
s.description = "'wip' provides tools to assist with the creation/maintenance of and collaboration on software projects"
|
18
|
+
|
19
|
+
s.files = `git ls-files`.split("\n")
|
20
|
+
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
21
|
+
s.executables = `git ls-files -- {bin}/*`.split("\n")
|
22
|
+
s.default_executable = "wip"
|
23
|
+
s.require_path = "lib"
|
24
|
+
|
25
|
+
s.add_development_dependency 'bundler', '~> 1.0.0'
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,92 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: wip
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
hash: 29
|
5
|
+
prerelease: false
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 0
|
9
|
+
- 1
|
10
|
+
version: 0.0.1
|
11
|
+
platform: ruby
|
12
|
+
authors:
|
13
|
+
- Corey Innis
|
14
|
+
autorequire:
|
15
|
+
bindir: bin
|
16
|
+
cert_chain: []
|
17
|
+
|
18
|
+
date: 2010-10-30 00:00:00 -07:00
|
19
|
+
default_executable: wip
|
20
|
+
dependencies:
|
21
|
+
- !ruby/object:Gem::Dependency
|
22
|
+
name: bundler
|
23
|
+
prerelease: false
|
24
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
hash: 23
|
30
|
+
segments:
|
31
|
+
- 1
|
32
|
+
- 0
|
33
|
+
- 0
|
34
|
+
version: 1.0.0
|
35
|
+
type: :development
|
36
|
+
version_requirements: *id001
|
37
|
+
description: "'wip' provides tools to assist with the creation/maintenance of and collaboration on software projects"
|
38
|
+
email:
|
39
|
+
- support+wip@coolerator.net
|
40
|
+
executables: []
|
41
|
+
|
42
|
+
extensions: []
|
43
|
+
|
44
|
+
extra_rdoc_files: []
|
45
|
+
|
46
|
+
files:
|
47
|
+
- .gitignore
|
48
|
+
- README.mkd
|
49
|
+
- Rakefile
|
50
|
+
- doc/README.md
|
51
|
+
- doc/TEMPLATE.md
|
52
|
+
- lib/wip.rb
|
53
|
+
- lib/wip/version.rb
|
54
|
+
- wip.gemspec
|
55
|
+
has_rdoc: true
|
56
|
+
homepage: http://github.com/coreyti/wip
|
57
|
+
licenses: []
|
58
|
+
|
59
|
+
post_install_message:
|
60
|
+
rdoc_options: []
|
61
|
+
|
62
|
+
require_paths:
|
63
|
+
- lib
|
64
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ">="
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
hash: 3
|
70
|
+
segments:
|
71
|
+
- 0
|
72
|
+
version: "0"
|
73
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
74
|
+
none: false
|
75
|
+
requirements:
|
76
|
+
- - ">"
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
hash: 23
|
79
|
+
segments:
|
80
|
+
- 1
|
81
|
+
- 3
|
82
|
+
- 6
|
83
|
+
version: 1.3.6
|
84
|
+
requirements: []
|
85
|
+
|
86
|
+
rubyforge_project:
|
87
|
+
rubygems_version: 1.3.7
|
88
|
+
signing_key:
|
89
|
+
specification_version: 3
|
90
|
+
summary: "'wip': streamlined work-in-progress projects"
|
91
|
+
test_files: []
|
92
|
+
|