From 45a0b4d1e73f5773e2bb5d8dff158d79b8249327 Mon Sep 17 00:00:00 2001 From: Koichi Murase Date: Sun, 28 Apr 2024 17:53:24 +0900 Subject: [PATCH] docs(README): mention other Markdown files --- CONTRIBUTING.md | 4 ++-- LICENSE.md | 18 +++++++++++++++--- README.md | 14 ++++++++++++-- 3 files changed, 29 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 040d585..b0f6e1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ you would make is not already covered. * [Issues](#reporting-issues) * [You have a problem](#you-have-a-problem) * [You have a suggestion](#you-have-a-suggestion) -* [Pull Requests](#submitting-pull-requests) +* [Pull Requests](#pull-requests) * [Getting started](#getting-started) * [You have a solution](#you-have-a-solution) * [New Theme](#new-theme) @@ -57,7 +57,7 @@ If you find one, comment on it so we can know there are more people supporting i If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. -## Submitting Pull Requests (PRs) +## Pull Requests The code should work with Bash 3.2. Make all the changes to be POSIX-compatible for external tools unless it is related to a plugin that diff --git a/LICENSE.md b/LICENSE.md index efd955f..bef4775 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,8 +1,20 @@ Copyright (c) 2009-2017 Robby Russell and contributors (https://github.com/ohmyzsh/ohmyzsh/contributors) Copyright 2017-2020 Toan Nguyen and contributors (https://github.com/ohmybash/oh-my-bash/graphs/contributors) -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: +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 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. +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. diff --git a/README.md b/README.md index 4b1d0c7..f80b232 100644 --- a/README.md +++ b/README.md @@ -280,9 +280,18 @@ If you want to uninstall `oh-my-bash`, just run `uninstall_oh_my_bash` from the ## Contributing -I'm far from being a [Bash](https://www.gnu.org/software/bash/) expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests! +Check out [`CONTRIBUTING.md`](Contributing.md) and also [Code of +Conduct](`CODE_OF_CONDUCT.md`). -We also need people to test out pull-requests. So take a look through [the open issues](https://github.com/ohmybash/oh-my-bash/issues) and help where you can. +This project is initially ported from Oh My Zsh and Bash-it by `@nntoan` and +has been developed in a community-driven way. Most of the contributors are far +from being a [Bash](https://www.gnu.org/software/bash/) expert, and there are +many ways to improve the codebase. If you have ideas on how to make the +configuration easier to maintain (and faster), don't hesitate to fork and send +pull requests! + +We also need people to test out pull-requests. Take a look through [the open +issues](https://github.com/ohmybash/oh-my-bash/issues) and help where you can. ## Contributors @@ -292,5 +301,6 @@ Thank you so much! ## License +See [`LICENSE.md`](License.md). Oh My Bash is derived from [Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh). Oh My Bash is released under the [MIT license](LICENSE.md).