Skip to content

Commit 9e7d95d

Browse files
mudrd8mzmudrd8mz
committed
MDL-53081 docs: Improve the text doc files in the root directory
Existing contents of README moved to INSTALL. Added new README, CONTRIBUTING and PULL_REQUEST_TEMPLATE files. TRADEMARK updated using the text at https://moodle.com/trademarks/.
1 parent 83a9510 commit 9e7d95d

5 files changed

+152
-56
lines changed

‎CONTRIBUTING.txt

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
CONTRIBUTING TO MOODLE
2+
======================
3+
4+
Moodle is made by people like you. We are members of a big worldwide community
5+
of developers, designers, teachers, testers, translators and other users. We
6+
work in universities, schools, companies and other places. You are very welcome
7+
to join us and contribute to the project.
8+
9+
See <https://docs.moodle.org/dev/Contributing_to_Moodle> for the many ways you
10+
can help, not only with coding.
11+
12+
Moodle is open to community contributions to core, though all code must go
13+
through peer-review, automated behaviour testing, continuous integration and
14+
human post-integration checks.
15+
16+
Pull requests
17+
-------------
18+
19+
Please do not open pull requests via Github. The repository there is just a
20+
mirror of the official repository at <https://git.moodle.org>. Issues are
21+
reported and patches provided via <https://tracker.moodle.org>. See below for
22+
more information.
23+
24+
Moodle core bug fixes and new features
25+
--------------------------------------
26+
27+
During the years of intensive development, a mature process of including
28+
submitted patches has evolved.
29+
30+
* Every bug fix or new feature must have a tracker issue.
31+
* You publish the branch implementing the fix or new feature in your public
32+
clone of the moodle.git repository (typically on Github).
33+
* Your patch is peer-reviewed, discussed, integrated, tested and then released
34+
as a part of moodle.git.
35+
* New features are developed on the master branch. Bug fixes are also
36+
backported to currently supported maintenance (stable) branches.
37+
38+
For further details, see <https://docs.moodle.org/dev/Process>.
39+
40+
Moodle plugins
41+
--------------
42+
43+
Moodle has a framework for additional plugins to extend its functionality. We
44+
have a Moodle plugins directory <https://moodle.org/plugins/> where you can
45+
register and maintain your plugin. Plugins hosted in the plugins directory can
46+
be easily installed and updated via the Moodle administration interface.
47+
48+
* You are expected to have a public source code repository with your plugin
49+
code.
50+
* After registering your plugin in the plugins directory it is reviewed before
51+
being published.
52+
* You are expected to continuously release updated versions of the plugin via
53+
the plugins directory. We do not pull from your code repository; you must do
54+
it explicitly.
55+
56+
For further details, see <https://docs.moodle.org/dev/Plugin_contribution>.

‎INSTALL.txt

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
MOODLE INSTALLATION
2+
===================
3+
4+
Here is a short summary of the installation process (which can take just a few
5+
minutes):
6+
7+
1. Move the Moodle files into your web directory.
8+
9+
2. Create a single database for Moodle to store all its tables in (or choose an
10+
existing database).
11+
12+
3. Visit your Moodle site with a browser. You should be taken to the
13+
install.php script, which will lead you through creating a config.php file
14+
and then setting up Moodle, creating an admin account etc.
15+
16+
4. Set up a cron task to call the file admin/cron.php every minute.
17+
18+
For more information, see <https://docs.moodle.org/en/Installing_Moodle>.
19+
20+
Good luck and have fun!

‎PULL_REQUEST_TEMPLATE.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
*** PLEASE DO NOT OPEN PULL REQUESTS VIA GITHUB ***
2+
3+
The moodle.git repository at Github is just a mirror of the official repository. We do not accept pull requests at Github.
4+
5+
See CONTRIBUTING.txt guidelines for how to contribute patches for Moodle. Thank you.
6+
7+
--

‎README.txt

+21-22
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
1-
QUICK INSTALL
2-
=============
1+
.-..-.
2+
_____ | || |
3+
/____/-.---_ .---. .---. .-.| || | .---.
4+
| | _ _ |/ _ \/ _ \/ _ || |/ __ \
5+
* | | | | | || |_| || |_| || |_| || || |___/
6+
|_| |_| |_|\_____/\_____/\_____||_|\_____)
37

4-
For the impatient, here is a basic outline of the
5-
installation process, which normally takes me only
6-
a few minutes:
8+
Moodle - the world's open source learning platform
79

8-
1) Move the Moodle files into your web directory.
10+
Moodle <https://moodle.org> is a learning platform designed to provide
11+
educators, administrators and learners with a single robust, secure and
12+
integrated system to create personalised learning environments.
913

10-
2) Create a single database for Moodle to store all
11-
its tables in (or choose an existing database).
14+
You can download Moodle <https://download.moodle.org> and run it on your own
15+
web server, ask one of our Moodle Partners <https://moodle.com/partners/> to
16+
assist you, or have a MoodleCloud site <https://moodle.com/cloud/> set up for
17+
you.
1218

13-
3) Visit your Moodle site with a browser, you should
14-
be taken to the install.php script, which will lead
15-
you through creating a config.php file and then
16-
setting up Moodle, creating an admin account etc.
19+
Moodle is widely used around the world by universities, schools, companies and
20+
all manner of organisations and individuals.
1721

18-
4) Set up a cron task to call the file admin/cron.php
19-
every five minutes or so.
22+
Moodle is provided freely as open source software, under the GNU General Public
23+
License <https://docs.moodle.org/dev/License>.
2024

25+
Moodle is written in PHP and JavaScript and uses an SQL database for storing
26+
the data.
2127

22-
For more information, see the INSTALL DOCUMENTATION:
23-
24-
http://docs.moodle.org/en/Installing_Moodle
25-
26-
27-
Good luck and have fun!
28-
Martin Dougiamas, Lead Developer
29-
28+
See <https://docs.moodle.org> for details of Moodle's many features.

‎TRADEMARK.txt

+48-34
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,48 @@
1-
------------------------
2-
Moodle Trademark License
3-
------------------------
4-
5-
The name Moodle™ is a registered trademark of the Moodle Trust.
6-
7-
A key part of the business model that allows us to produce and
8-
distribute Moodle as completely Free open source software is that
9-
we restrict the commercial use of the Moodle trademark to those
10-
who have contracted to support Moodle development (Moodle Partners).
11-
12-
If you are intending to use the name (and/or logo) to advertise
13-
generic Moodle™ services (eg Moodle Hosting, Moodle Support,
14-
Moodle Certification, Moodle Training, Moodle Consulting,
15-
Moodle Customisation, Moodle Courseware Development, Moodle
16-
Theme design, Moodle Integrations, Moodle Installations, etc)
17-
or as the name of a software package, then you must seek
18-
direct permission in writing from the Moodle Trust via the
19-
moodle.com helpdesk, in accordance with normal trademark
20-
restrictions.
21-
22-
There are no restrictions on how you use the name in other
23-
contexts (for example, if you use Moodle just to provide
24-
courses then you can use the name freely to refer to it.)
25-
26-
If you aren't sure of a particular case, please ask us via
27-
http://moodle.com/helpdesk: we'll be happy to either provide
28-
you with official permission in writing or help you fix
29-
your wording.
30-
31-
Martin Dougiamas
32-
Executive Director
33-
Moodle Trust
34-
http://moodle.com
1+
MOODLE TRADEMARKS POLICY
2+
========================
3+
4+
The word "Moodle" is trademarked in many countries around the world. The word
5+
was originally an acronym: Modular Object-Oriented Dynamic Learning
6+
Environment. The trademark is owned by Martin Dougiamas, Founder and Director
7+
of Moodle.
8+
9+
The law obligates trademark owners to police their marks and prevent the use of
10+
confusingly similar names by third parties. Through this policy we’d like to
11+
make it clear how Moodle-related projects, organisations, and people can use
12+
the Moodle trademark. We’d also like to be clear about how use of the word is
13+
restricted when used to promote commercial Moodle services. We do this to
14+
protect the very business model that allows us to continue developing Moodle
15+
for you.
16+
17+
Allowed uses
18+
------------
19+
20+
The following uses don’t require any permission at all:
21+
22+
* Referring to the software or the Moodle project.
23+
* Describing your own Moodle implementation (including within corporate
24+
settings).
25+
* Describing a Moodle-based community hub.
26+
* Describing some software you’ve made that integrates with Moodle
27+
(eg a Moodle integration feature on another system).
28+
29+
Restricted uses
30+
---------------
31+
32+
The following uses are generally prohibited without explicit and direct
33+
permission being granted to you by Moodle Pty Ltd. We do this to protect the
34+
Moodle project from software and sites which could confuse people. Please
35+
contact us to ask for permission in writing.
36+
37+
* You can’t use "Moodle" in the name of your software (including Mobile apps)
38+
* You can’t use "Moodle" in your company name
39+
* You can’t use "Moodle" in your domain name
40+
* You can’t use "Moodle" in advertising-related keywords (such as Adsense)
41+
* You can’t use "Moodle" to describe services around Moodle (such as hosting,
42+
training, support, consulting, course creation services, theme development,
43+
customisation, installation, integration and certification). This applies
44+
even if you do not charge for the services. Note that usually only Moodle
45+
Partners have this permission.
46+
47+
For information about the Moodle Partner Certification Mark as well as for how
48+
to contact us, please see <https://moodle.com/trademarks/>.

0 commit comments

Comments
 (0)