From c6c489cdc0e08587734aebef80253e1a6a193acf Mon Sep 17 00:00:00 2001 From: dethe <76167420+detherminal@users.noreply.github.com> Date: Sun, 21 Jul 2024 13:40:52 +0300 Subject: [PATCH] add readme and license --- LICENSE.md | 13 +++++++++++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..a3a8e97 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,13 @@ +Copyright (c) 2024, The Monero Project + +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +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. + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad78bce --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Monero Docs + +This repository contains source files of official Monero documentation hosted at [docs.getmonero.org](https://docs.getmonero.org). + +## Structure + +This repository uses [Jekyll](https://jekyllrb.com/) and [just-the-docs](https://just-the-docs.com/). + +To build the project locally, you have to do the following steps: + +- Install Ruby from your package manager +- Install Jekyll and Bundler: `gem install jekyll bundler` +- Install dependencies: `bundle install` +- Build and serve the project: `bundle exec jekyll serve` + +After all these, it should be running on port 4000 locally by default. + +## Changes + +Changes and contributing is **very welcomed** in this repository. To contribute, fork and make a pull request to the master branch including your changes. Please ask the community or create a [discussion](https://github.com/monero-project/monero-docs/discussions/new/choose) before making macro-level changes. + +## License + +The source files, documentation and assets are copyrighted under [BSD 3-Clause "New" or "Revised" License](LICENSE.md).