Project

wtf-doc

0.0
No commit activity in last 3 years
No release in over 3 years
Run $ wtf to read/write the documentation of the current folder
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 10.0
>= 0

Runtime

= 0.19.1
 Project Readme

Wtf-doc - small command line utility to add documentation to the folders

Never run into so many folders that you have no idea what contains what? This is a tool to add a descriptions to your folders. Especially useful in Linux servers when collaborating with many other people. A .wtf file is created into the current folder and a small description can be added and readed from it just by running 'wtf' in the command line.

This small utility will create a .wtf file containing a txt description of the current folder

Installation

Install it yourself as:

$ gem install wtf-doc

Usage

$ wtf # to know that is going on into a folder
$ wtf doc # to add a description to a folder
$ wtf clean # to cleanup the .wtf file from a folder

Contributing

Bug reports and pull requests are very welcome on GitHub at https://github.com/lorenzosinisi/wtf.

License

Copyright (c) 2015-2016 Lorenzo Sinisi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.