From 05f5a0ae9f1ec4de008cee9fcd752f0229e0ba7a Mon Sep 17 00:00:00 2001 From: linuxdaemon Date: Sat, 12 Oct 2019 08:51:32 -0500 Subject: [PATCH] Replace README --- README.md | 89 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 87 deletions(-) diff --git a/README.md b/README.md index 8150d0f4..1c50ac1b 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,2 @@ -# CloudBot -![Python application](https://github.com/TotallyNotRobots/CloudBot/workflows/Python%20application/badge.svg) -[![CodeFactor](https://www.codefactor.io/repository/github/totallynotrobots/cloudbot/badge/main)](https://www.codefactor.io/repository/github/totallynotrobots/cloudbot/overview/main) -[![codebeat badge](https://codebeat.co/badges/a684cbb3-15a0-4ff2-a8cd-7d9cfad2ce2a)](https://codebeat.co/projects/github-com-totallynotrobots-cloudbot-main) -[![codecov](https://codecov.io/gh/TotallyNotRobots/CloudBot/branch/main/graph/badge.svg)](https://codecov.io/gh/TotallyNotRobots/CloudBot) - -CloudBot is a simple, fast, expandable open-source Python IRC Bot! - -## Getting CloudBot - -You have a few options for getting the bot, you can: -* Clone the `main` branch of this repository, using `git pull` to update -* Download the [latest source] -* Download the [latest release] - -## Installing CloudBot - -Firstly, CloudBot will only run on **Python 3.6 or higher** - -To install CloudBot on *nix (linux, etc), see [here](docs/installing/nix.md) - -To install CloudBot on Windows, see [here](docs/installing/win.md) - - -### Running CloudBot - -Before you run the bot, rename `config.default.json` to `config.json` and edit it with your preferred settings. You can check if your JSON is valid using [jsonlint.com](http://jsonlint.com/)! - -Once you have installed the required dependencies and renamed the config file, you can run the bot! Make sure you are in the correct folder and run the following command: - -``` -python3 -m cloudbot -``` - -## Getting help with CloudBot - -### Documentation - -The CloudBot documentation is currently somewhat outdated and may not be correct. If you need any help, please visit our [IRC channel](#support) and we will be happy to assist you. - - -### Support - -The developers reside in [#gonzobot-dev](https://webchat.snoonet.org/#gonzobot-dev) on [Snoonet](https://snoonet.org) and would be glad to help you. - -If you think you have found a bug/have a idea/suggestion, please **open a issue** here on Github and contact us on IRC! - -## Contributing - -See [CONTRIBUTING.md](CONTRIBUTING.md) - -## Changelog - -See [CHANGELOG.md](CHANGELOG.md) - -## License - -CloudBot is **licensed** under the **GPL v3** license. The terms are as follows. - -![GPL V3](https://www.gnu.org/graphics/gplv3-127x51.png) - - CloudBot - - Copyright © 2011-2015 Luke Rogers / CloudBot Project - - CloudBot is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - CloudBot is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with CloudBot. If not, see . - -![Powered by wordnik](https://www.wordnik.com/img/wordnik_badge_a1.png) - -TV information is provided by [TheTVDB.com], but we are not endorsed or certified by [TheTVDB.com] or its affiliates. - -This product uses data from http://wordnik.com in accordance with the wordnik.com API terms of service. - -[latest source]: https://github.com/TotallyNotRobots/CloudBot/archive/main.zip -[latest release]: https://github.com/TotallyNotRobots/CloudBot/releases/latest -[TheTVDB.com]: https://thetvdb.com/ +mycroft +---