From ed4bda72b4c043b0d7c8a96c52f915d65f5fa88e Mon Sep 17 00:00:00 2001 From: Jean-Michel Vedrine Date: Sat, 27 Apr 2019 16:34:01 +0200 Subject: Update readmle --- CHANGELOG.txt | 3 +-- INSTALL.txt | 42 ------------------------------------------ README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.txt | 40 ---------------------------------------- 4 files changed, 57 insertions(+), 84 deletions(-) delete mode 100644 INSTALL.txt create mode 100644 README.md delete mode 100644 README.txt diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 31a74c4..446e7ce 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -1,9 +1,8 @@ Version New setting to select the default comparison method -MathJax will be used for TeX rendering if MathJax isinstalled unsing +MathJax will be used for TeX rendering if MathJax is installed Additionnal HTML in HEAD (will not work if Mathjax is installed using a theme) -Version Version 0.0.4 Improvements diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index 3a7ed3f..0000000 --- a/INSTALL.txt +++ /dev/null @@ -1,42 +0,0 @@ -INSTALLATION INSTRUCTIONS - -Before installation: Please note that this is ALPHA quality software at -the moment. DO NOT install this on your production server - or at least -don't blame me if you do and it all goes horribly wrong! - - -REQUIREMENTS - -To install the algebra based question type you will need the following: - -1) Already installed copy of Moodle 2.3 or higher. It was tested with Moodle -2.3 and 2.4. - - -3) If you want to use the SAGE XML-RPC server you will also need XML-RPC - support in PHP5. Most installations include this but the MAMP 1.7.1 - package does not. If you use MAMP you will need to download the MAMP - source code from the MAMP website and recompile PHP making sure you - call the initial configure script with the flag "--with-xmlrpc". - -4) If you want to use the SAGE XML-RPC server you will also need a copy of - SAGE which you can get from here: http://www.sagemath.org/. This should - be installed according to the instructions on their website. - - -INSTALLING - -1) Copy the contents of the "algebra" directory into the question/type - subdirectory of your moodle directory. - -2) Go to Site Administration > Notifications and follow the usual procedure - to upgrade a Moodle plugin. You are now ready to write algebra based questions - which use the 'Evaluate' and 'Equivalent' comparison methods. - -3) To run the SAGE XML-RPC server you will need an installed copy of SAGE - (http://www.sagemath.org/). Edit the first line of the 'sage-server.py' - file to point to your installed copy of the sage executable. Then simply - execute the sage-server.py script. It will run a very simple XML-RPC - server. If the machine you run your moodle server on is different from - the machine running your SAGE webserver you will need to enter the full - url diff --git a/README.md b/README.md new file mode 100644 index 0000000..2ea3f34 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +MOODLE ALGEBRA QUESTION TYPE +---------------------------- + +Created by Roger Moore + +ORIGINAL README BY ROGER MOORE: + +These files implement a algebra based question type for Moodle. +Installation instructions are found in the file INSTALL. + +The code has been tested and used for a large, introductory physics +course (~120 students) at the University of Alberta for several +terms now and is stable and suitable for use in a production +environment. + +The code is all released under the GPL V3. + +Please send any bugs, comments, suggestions for new features etc. +to me. + +Enjoy, + +Roger Moore + +ADDITIONAL README + +Updated to Moodle 2.0 by Stefan Raffeiner +Updated to Moodle 2.1 by Jean-Michel Védrine + +This plugin is now maintained by Jean-Michel Védrine. This version is upgraded to +work with Moodle 2.8 and ulteriors versions. + +For support use the Moodle quiz forum at https://moodle.org/mod/forum/view.php?id=737 + +### Installation and set-up + +#### Install from the Moodle plugins database + + https://moodle.org/plugins/qtype_algebra + +#### Install using git + +To install using git, type these commands in the root of your Moodle install: +git clone https://github.com/jmvedrine/moodle-qtype_algebra.git question/type/algebra echo '/question/type/algebra/' >> .git/info/exclude + +Then run the moodle update process Site administration > Notifications + +Enjoy. + +Jean-Michel Védrine + +WARNING : +I am now retired and I stopped all Moodle related activities. +This repository is here just for history and this work is not maintained any more. +Feel free to fork it and modify it to suit your needs or improve compatibility with recent Moodle versions. +Additionaly you can consider contacting the Moodle team and become the new maintainer of this lugin. Thanks diff --git a/README.txt b/README.txt deleted file mode 100644 index afe04d8..0000000 --- a/README.txt +++ /dev/null @@ -1,40 +0,0 @@ -MOODLE ALGEBRA QUESTION TYPE -Created by Roger Moore - -ORIGINAL README BY ROGER MOORE: - -These files implement a algebra based question type for Moodle. -Installation instructions are found in the file INSTALL. - -The code has been tested and used for a large, introductory physics -course (~120 students) at the University of Alberta for several -terms now and is stable and suitable for use in a production -environment. - -The code is all released under the GPL V3. - -Please send any bugs, comments, suggestions for new features etc. -to me. - -Enjoy, - -Roger Moore - -ADDITIONAL README - -Updated to Moodle 2.0 by Stefan Raffeiner -Updated to Moodle 2.1 by Jean-Michel Védrine - -This plugin is now maintained by Jean-Michel Védrine. This version is upgraded to -work with Moodle 2.8 and ulteriors versions. -For support use the Moodle quiz forum at https://moodle.org/mod/forum/view.php?id=737 - -Enjoy. - -Jean-Michel Védrine - -WARNING : -I am now retired and I stopped all Moodle related activities. -This repository is here just for history and this work is not maintained any more. -Feel free to fork it and modify it to suit your needs or improve compatibility with recent Moodle versions. -Additionaly you can consider contacting the Moodle team and become the new maintainer of this lugin. Thanks -- cgit v1.2.3