Permalink
Browse files

add some dev docs

  • Loading branch information...
1 parent 89fc213 commit 460e6fe1689468823cff172bd3bac7cb0a6dc16c @tj tj committed Aug 3, 2012
Showing with 10 additions and 0 deletions.
  1. +10 −0 Readme.md
View
@@ -3,6 +3,16 @@
Component package manager consuming git repositories
+## Developing component(1)
+
+ `component(1)` and sub-commands are structured much like `git(1)`,
+ in that sub-commands are simply separate executables. For example
+ `$ component info pkg` and `$ component-info pkg` are equivalent.
+
+ Because of this you'll likely want `PATH="./bin:$PATH"` in your
+ profile or session while developing component, otherwise `./bin/component`
+ will have a hard time finding the sub-commands.
+
## License
(The MIT License)

0 comments on commit 460e6fe

Please sign in to comment.