Skip to content

Commit

Permalink
change license to BSD3, add to README, change configure.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
c650 committed Dec 31, 2016
1 parent e8cfbd2 commit 4a31a99
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 19 deletions.
37 changes: 20 additions & 17 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
The MIT License (MIT)
Copyright 2016 c650

Copyright (c) 2016 Charles Bailey
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

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:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

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.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Anyone is free to customize it, add to it, or even contribute in making a better
All of this code is licensed under the MIT License.

---
# Building and Using
# Usage

The code in [src/IRCBot](/src/IRCBot) is what is needed to use this framework.

Expand Down Expand Up @@ -50,6 +50,19 @@ Use the following line to add the command to a bot:

To run the bot, information must be specified like it is in the [sample config](/sample-config.json).

---
# Compiling

First, run `./configure`. If you aren't using a Debian-based linux, the dependencies are **libcurl** and **openSSL/libssl** and you must install them manually. If you intend to compile from source, the `*-dev` packages, as well as a C++ compiler, are also needed.

A 64-bit linux binary is on the releases page. For any other architecture or OS, please do the following:

mkdir bin
make
./bin/bot.out [optional argument with path to configuration file]

**NOTE**: You may want to run the bot from inside a Docker container.

---

I have added a few commands as an example, but they needn't stay if you don't want them to.
Expand All @@ -58,3 +71,8 @@ I have added a few commands as an example, but they needn't stay if you don't wa
# Acknowledgements

Thanks to @nlohmann for his [C++ JSON Library](https://github.com/nlohmann/json).

---
# License

This project is licensed under the [Three-Clause BSD License](/LICENSE).
2 changes: 1 addition & 1 deletion configure.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

echo "Configuring... Checking dependencies..."

sudo apt install libcurl-dev libssl-dev
sudo apt install libcurl4-openssl-dev libssl-dev

0 comments on commit 4a31a99

Please sign in to comment.