README in dev-1.0.161 vs README in dev-1.0.162

- old
+ new

@@ -23,5 +23,51 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + =dev +the dev gem provides functionality to support the development of ruby,c#,c++ and c projects. +when the require 'dev' is used in a rakefile, the variable DEV is defined as well as +several rake tasks. +the DEV variable may be manipulated to modify behavior of defined tasks or to +cause additional task to be generated. + +==Installation +dev can be installed by the single command + gem install dev + +==Usage +dev can be included in a ruby script with + require 'dev' + +a constant PROJECT hash is the primary variable about which the dev functionality revolves +some example usages: + PROJECT=Dev::Project.new{( name: 'HelloRuby' )} + +===Simplest usage +DEV_HOME/wrk/Examples/HelloRuby/trunk/rakefile.rb + require 'dev' + +==Reference +===Variables +PROJECT is a global instance of a Hash. The variable may be define explictly with + PROJECT=Dev::Project.new({ name: 'example' }) +or may be automatically generated as needed when specific tasks are executed. + +===Tasks + rake add # add files defined by src_glob to source code management + rake check # checks if the project default task may be skipped + rake clean # Remove any temporary products. + rake clobber # Remove any generated file. + rake commit # commit + rake compile # compile + rake features # tests cucumber features + rake info # display information about the rakefile + rake loc # count the lines of code + rake pull # rake working copies of dependencies + rake replace # replace text + rake setup # setup the project environment + rake test # run unit tests + rake update # updates changes from source code management +