From e4e00227f6b12f716e4ef186fa66ecdab01aaef1 Mon Sep 17 00:00:00 2001 From: Kun Deng Date: Fri, 22 Mar 2019 21:53:42 -0400 Subject: [PATCH 1/4] Update README.md --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/README.md b/README.md index e69de29..a526eb8 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,52 @@ +# IcarusDownloadManager + +IcarusDownloadManager is a CLI program tool that has the feature of uploading and downloading songs from the [Icarus](https://github.com/amazing-username/Icarus) Music Server. + +### Prerequisites + +* CMake +* gcc +* libcurl +* [cpr](http://whoshuu.github.io/cpr/) + +### Installing + +Clone the repository and esnure that the cpr c++ module is implemented by checking the contents of the cpr directory. If you notice a directory structure and a *CMakeList.txt* file then you are fine. Otherwise implement the modules with the following command: + + +``` +git submodule update --init --recursive +``` + +Once that is complete, verify the contents of the cpr directory and there should be a *CMakeList.txt* file. Now you must compile and link the project + +``` +cmake . +make +``` + +The program has been built and can be executed by the binary file *icd* + + +## Built With + +* c++ + +## Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the code of conduct, and the process for submitting pull requests to the project. + +## Versioning + +No version has been released + +## Authors + +* **Kun Deng** - [amazing-username](https://github.com/amazing-username) + +See also the list of [contributors](https://github.com/amazing-username/Icarus/graphs/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details + From 0fae5b4b1a2f7b01d0d03389841e72ea2f2c825d Mon Sep 17 00:00:00 2001 From: Kun Deng Date: Fri, 22 Mar 2019 21:54:10 -0400 Subject: [PATCH 2/4] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a07f809 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Kun Deng + +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. From c0486f971763e1a7bd4fa64e5dc0b9ba1a7f02a5 Mon Sep 17 00:00:00 2001 From: Kun Deng Date: Fri, 22 Mar 2019 21:55:31 -0400 Subject: [PATCH 3/4] Create CONTRIBUTING.md --- CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4e5592e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note the project has a code of conduct, please follow it in all your interactions with the project. + +## Code of Conduct + +### Pledge + +In the interest of fostering an open and welcoming environment, I as +aintainers pledge to making participation in this project and +this community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Maintainers Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## How You Can Contribute + +The project is always looking for people to help in anyway they can. The following would be greatly appreciated: + +* Developers +* Graphic Designers +* Documenters + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ From 3e8694cf944c67f568a2a22fc3643a517692639c Mon Sep 17 00:00:00 2001 From: Kun Deng Date: Fri, 22 Mar 2019 21:56:58 -0400 Subject: [PATCH 4/4] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index a526eb8..6b1a342 100644 --- a/README.md +++ b/README.md @@ -49,4 +49,3 @@ See also the list of [contributors](https://github.com/amazing-username/Icarus/g ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details -