organize 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/LICENSE +19 -0
  2. data/README.md +98 -0
  3. data/lib/organize/version.rb +1 -1
  4. metadata +5 -3
data/LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2010 Alexander Kern
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in
11
+ all copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,98 @@
1
+ organize
2
+ ========
3
+
4
+ Organize your Mac filesystem.
5
+
6
+ Huh?
7
+ ----
8
+
9
+ Organize helps you stay organized on your Mac. It sets up a very simple project
10
+ management system that works for me (maybe not you).
11
+
12
+ Install
13
+ -------
14
+
15
+ $ gem install organize
16
+ $ organize install
17
+
18
+ Now you can create some projects!
19
+
20
+ $ organize create FOSS
21
+ $ organize create Social
22
+ $ organize create Freelance
23
+ $ organize create ElDorado
24
+
25
+ What does this do for me?
26
+ -------------------------
27
+
28
+ Organize will create a folder in your home directory called Projects. Inside of
29
+ this folder you can place all of your projects. If you've ever used
30
+ [Things](http://culturedcode.com/things/) by CulturedCode, think of these
31
+ projects like Areas of Responsibility. These are *large* goals in your life that
32
+ won't be completed for a couple months or will never be completed. Don't make
33
+ too many of them. I usually have around 13 or so.
34
+
35
+ Inside of each project folder, there are two folders created for you
36
+ automatically. The Shared folder links to a folder in your
37
+ [Dropbox](http://www.dropbox.com/) of the same name as the project. Anything
38
+ that you'd like to share across multiple computers should be placed in here.
39
+
40
+ The other folder is the Archive folder. Treat this like the Archive folder of
41
+ Gmail. Don't delete things that you may possibly need later. Put them in the
42
+ Archive for storage.
43
+
44
+ Organize also creates a couple other folders. The Archive folder located in the
45
+ root of the Projects folder are for old projects that you've completed but would
46
+ like to still have the file around, just in case something bad happens. The
47
+ Inbox folder is a symlink to your Desktop. This folder and its corresponding
48
+ Shared folder are for things that you're either too lazy to fit into another
49
+ folder or are very temporary things that you'll never need for more than 5 or
50
+ ten minutes. Keep your desktop down to 5 or 6 items at all times.
51
+
52
+ The Other folder links your various home folder sections (like Documents,
53
+ Movies, Music, etc.) that don't quite fit into the organization system. The only
54
+ things that should go in these folders are resources which transcend the
55
+ projects. Your iTunes folder is a prime example, along with [Parallels
56
+ VMs](http://www.parallels.com/products/desktop/) and movies you've downloaded.
57
+ This folder also has a Shared folder for things like your
58
+ [1Password](http://agilewebsolutions.com/products/1Password) keychain.
59
+
60
+ That's it.
61
+
62
+ Awesome! How can I make this even cooler?
63
+ -----------------------------------------
64
+
65
+ You can make your life easier by adding a simple little function to your zsh.
66
+
67
+ cd ~/Projects/$1;
68
+
69
+ If you save it as a short name like `p`, you can just do a simple little:
70
+
71
+ p FOSS
72
+
73
+ to get to your FOSS project. Ohhh yeahhh!
74
+
75
+ You can even make it autocomplete!
76
+
77
+ #compdef p
78
+ _files -W ~/Projects -/
79
+
80
+ Crazy!
81
+
82
+ Just as a small cosmetic enhancement, I like using the icon of the Utilities
83
+ folder for my Projects folder. It kinda make it fit in more when viewed in the
84
+ Finder.
85
+
86
+ Note on Patches/Pull Requests
87
+ -----------------------------
88
+
89
+ * Fork the project.
90
+ * Make your feature addition or bug fix.
91
+ * Add tests for it. This is important so I don’t break it in a future version unintentionally.
92
+ * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
93
+ * Send me a pull request. Bonus points for topic branches.
94
+
95
+ Copyright
96
+ ---------
97
+
98
+ See the LICENSE for details.
@@ -1,3 +1,3 @@
1
1
  module Organize
2
- VERSION = '1.0.0'
2
+ VERSION = '1.0.1'
3
3
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: organize
3
3
  version: !ruby/object:Gem::Version
4
- hash: 23
4
+ hash: 21
5
5
  prerelease: false
6
6
  segments:
7
7
  - 1
8
8
  - 0
9
- - 0
10
- version: 1.0.0
9
+ - 1
10
+ version: 1.0.1
11
11
  platform: ruby
12
12
  authors:
13
13
  - Alexander Kern
@@ -141,6 +141,8 @@ files:
141
141
  - .rspec
142
142
  - Gemfile
143
143
  - Gemfile.lock
144
+ - LICENSE
145
+ - README.md
144
146
  - Rakefile
145
147
  - bin/organize
146
148
  - lib/organize.rb