|
| 1 | +#  |
| 2 | + |
| 3 | +# Gorganizer     |
| 4 | + |
| 5 | +==== |
| 6 | + |
| 7 | +Gorganizer is a Go program inspired by [Bhrigu Srivastava][bhrigu123] [Classifier Project][classifier]. |
| 8 | + |
| 9 | +The Gorganizer goal is to be a perfect tool providing a stupidly easy to use and fast program to organize your files based on its extension. |
| 10 | + |
| 11 | +[bhrigu123]: https://github.com/bhrigu123 |
| 12 | +[classifier]: https://github.com/bhrigu123/classifier |
| 13 | + |
| 14 | +## Project Status |
| 15 | + |
| 16 | +Gorganizer is on beta |
| 17 | + |
| 18 | +Bolt is stable, more features will be added and full unit tests will be made. |
| 19 | +Pull Requests [are welcome](https://github.com/DiSiqueira/Gorganizer#social-coding) |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | +## Features |
| 24 | + |
| 25 | +- It's perfect to organize your downloads folder |
| 26 | +- Instantly organize your files |
| 27 | +- Customize to your needs |
| 28 | +- Easy to add rules |
| 29 | +- Easy to delete default rules |
| 30 | +- Stupidly [easy to use](https://github.com/DiSiqueira/Gorganizer#usage) |
| 31 | +- Very fast start up and response time |
| 32 | +- Uses natives libs |
| 33 | +- Only one dependency - [BoltDB](https://github.com/boltdb/bolt) |
| 34 | +- Option to organize your files |
| 35 | + |
| 36 | +## Installation |
| 37 | + |
| 38 | +### Option 1: Download binary |
| 39 | + |
| 40 | +```bash |
| 41 | +$ |
| 42 | +``` |
| 43 | + |
| 44 | +### Option 2: From source |
| 45 | + |
| 46 | +```bash |
| 47 | +$ go get github.com/boltdb/bolt/... |
| 48 | +$ git clone https://github.com/DiSiqueira/Gorganizer.git |
| 49 | +$ cd Gorganizer/src |
| 50 | +$ go build *.go |
| 51 | +``` |
| 52 | + |
| 53 | +## Usage |
| 54 | + |
| 55 | +### Basic usage |
| 56 | + |
| 57 | +```bash |
| 58 | +# Organize your current directory |
| 59 | +$ ./gorganizer |
| 60 | +``` |
| 61 | + |
| 62 | +### Add new rule |
| 63 | + |
| 64 | +```bash |
| 65 | +# Add .py to Python folder |
| 66 | +$ ./gorganizer -newrule=py:Python |
| 67 | +``` |
| 68 | + |
| 69 | +### Delete existing rule |
| 70 | + |
| 71 | +```bash |
| 72 | +# Delete txt rule |
| 73 | +$ ./gorganizer -delrule=txt |
| 74 | +``` |
| 75 | + |
| 76 | +### Print all rules |
| 77 | + |
| 78 | +```bash |
| 79 | +# Delete txt rule |
| 80 | +$ ./gorganizer -allrules=true |
| 81 | +``` |
| 82 | + |
| 83 | +### Move organized files to another folder |
| 84 | + |
| 85 | +```bash |
| 86 | +# Run in current directory and move organized files to ~/Downloads |
| 87 | +$ ./gorganizer -output=~/Downloads |
| 88 | +``` |
| 89 | + |
| 90 | +### Run in other directory |
| 91 | + |
| 92 | +```bash |
| 93 | +# Run in ~/Downloads |
| 94 | +$ ./gorganizer -directory=~/Downloads |
| 95 | +``` |
| 96 | + |
| 97 | +### Run in other directory and send organized files to a organized one |
| 98 | + |
| 99 | +```bash |
| 100 | +# Run in ~/Downloads |
| 101 | +$ ./gorganizer -directory=~/Downloads -output=~/Documents |
| 102 | +``` |
| 103 | + |
| 104 | +### Show help |
| 105 | + |
| 106 | +```bash |
| 107 | +$ ./gorganizer -h |
| 108 | +``` |
| 109 | + |
| 110 | +## Program Help |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +## Contributing |
| 115 | + |
| 116 | +### Bug Reports & Feature Requests |
| 117 | + |
| 118 | +Please use the [issue tracker](https://github.com/DiSiqueira/Gorganizer/issues) to report any bugs or file feature requests. |
| 119 | + |
| 120 | +### Developing |
| 121 | + |
| 122 | +PRs are welcome. To begin developing, do this: |
| 123 | + |
| 124 | +```bash |
| 125 | +$ go get github.com/boltdb/bolt/... |
| 126 | +$ git clone --recursive [email protected]:DiSiqueira/Gorganizer.git |
| 127 | +$ cd Gorganizer/src/ |
| 128 | +$ go run *.go |
| 129 | +``` |
| 130 | + |
| 131 | +## Social Coding |
| 132 | + |
| 133 | +1. Create an issue to discuss about your idea |
| 134 | +2. [Fork it] (https://github.com/DiSiqueira/Gorganizer/fork) |
| 135 | +3. Create your feature branch (`git checkout -b my-new-feature`) |
| 136 | +4. Commit your changes (`git commit -am 'Add some feature'`) |
| 137 | +5. Push to the branch (`git push origin my-new-feature`) |
| 138 | +6. Create a new Pull Request |
| 139 | +7. Profit! :white_check_mark: |
| 140 | + |
| 141 | +## License |
| 142 | + |
| 143 | +The MIT License (MIT) |
| 144 | + |
| 145 | +Copyright (c) 2013-2015 Diego Siqueira |
| 146 | + |
| 147 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 148 | +of this software and associated documentation files (the "Software"), to deal |
| 149 | +in the Software without restriction, including without limitation the rights |
| 150 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 151 | +copies of the Software, and to permit persons to whom the Software is |
| 152 | +furnished to do so, subject to the following conditions: |
| 153 | + |
| 154 | +The above copyright notice and this permission notice shall be included in |
| 155 | +all copies or substantial portions of the Software. |
| 156 | + |
| 157 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 158 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 159 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 160 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 161 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 162 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 163 | +THE SOFTWARE. |
0 commit comments