https://github.com/mohnish/opensource.sh
FOR AN UPGRADED & MAINTAINED VERSION PLEASE CHECK THIS URL https://github.com/mohnish/opensource
https://github.com/mohnish/opensource.sh
Last synced: 3 months ago
JSON representation
FOR AN UPGRADED & MAINTAINED VERSION PLEASE CHECK THIS URL https://github.com/mohnish/opensource
- Host: GitHub
- URL: https://github.com/mohnish/opensource.sh
- Owner: mohnish
- License: mit
- Created: 2012-12-15T22:34:19.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2013-02-20T06:13:08.000Z (over 13 years ago)
- Last Synced: 2025-01-10T20:57:44.169Z (over 1 year ago)
- Language: Shell
- Homepage: https://github.com/mohnish/opensource
- Size: 308 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## OpenSource
OpenSource is a tiny shell script that allows you to add the license you wish to add to your project.
### Installation
- First `cd ~`
- Next `git clone git@github.com:mohnish/opensource.git`
- Then `cd opensource/` and `chmod 755 opensource`.
### Setup
- Setup your information in the `config/user.rc` file.
- Set `USER="YourName"` and `EMAIL="YourEmail"`, each in it's own line.
### Usage
- `~/opensource/opensource [options] /path/to/project`.
- `opensource` also supports relative paths like `.` or `path/../../../to/project`.
- For a list of options available with `opensource`, you can use the `-h` flag.
It can be used as: `opensource -h` or `opensource --help`.
### Sample
Here is a sample generated license file: [LICENSE](https://github.com/mohnish/opensource/blob/master/LICENSE)
### TODO
- Add support to multiple opensource licenses
- Add support to mulptiple file formats such as markdown, text etc.
I happen to be new to shell scripting, so please do pardon my poor coding style & quality. I would love to have people push updates to this repository to fix/improve the existing code. Thanks in advance. Suggestions for betterment of the project are welcome.
Lots of [<3](http://twitter.com/arrowgunz)
## License
MIT