Skip to content
Snippets Groups Projects
Commit 1f3ffe74 authored by Chris Sangwin's avatar Chris Sangwin
Browse files

Update the docs.

parent 3755f6c8
No related branches found
No related tags found
No related merge requests found
......@@ -20,4 +20,4 @@ The [documentation is here](https://github.com/maths/moodle-qtype_stack/blob/mas
## License
Stack is Licensed under the [GNU General Public, License Version 3](https://github.com/maths/moodle-qtype_stack/blob/master/COPYING.txt).
STACK is Licensed under the [GNU General Public, License Version 3](https://github.com/maths/moodle-qtype_stack/blob/master/COPYING.txt).
......@@ -19,11 +19,11 @@ Check
* version.php
* check both the Moodle versions, and the required number. (https://docs.moodle.org/dev/Releases)
* Check version numbers on stackmaxima.mac.
* Commit all changes to git, e.g. "Update version number for the 4.0 release."
* Run unit tests.
* Run code checker.
* Commit all changes to git, e.g. "Update version number for the 4.3 release."
## 2. Run all unit tests
## 3. Create new tag with version name
## 2. Create new tag with version name
E.g. "v4.3".
......@@ -33,7 +33,7 @@ E.g. "v4.3".
* Unix: `git tag -a v4.3 -m "Update version number for the 4.3 release."`
* Unix: `git push --tags`
## Moodle plugins database entry for the plugin
## 3. Moodle plugins database entry for the plugin
Add a new version to the Moodle plugins database entry for the plugin.
......
......@@ -58,14 +58,6 @@ Maxima is the rate-determining step in performance to STACK. Once you have the S
At any stage you can evaluate a fragment of CASText by using the CASChat script. There is a link from the STACK configuration page.
# Test results
As of 2015-9-17, STACK has been tested on the following versions of Maxima.
* 5.31.3 = PASS
* branch_5_35_base_87_g454731b = PASS (compiled from source)
* 5.36.1 = PASS
## Testing your questions when you upgrade
Whenever you upgrade to a new version of the STACK plugin, it is a really good idea to run all
......
......@@ -12,9 +12,9 @@ On an existing Moodle site navigate to
/admin/environment.php
to confirm before adding this plugin.
to confirm before adding this plug-in.
On some linux distros, you simply need to
On some Linux distros, you simply need to
apt-get install php-mbstring
......@@ -22,10 +22,10 @@ and then re-start the webserver.
## 1. Set up Moodle.
* Please ensure you have [installed Moodle](http://docs.moodle.org/en/Main_page). We intend to support STACK within the normal Moodle [release cycle](https://docs.moodle.org/dev/Releases). STACK 4.3 has been tested on Moodle 3.5, 3.6, 3.7 and 3.8. STACK is untested on versions before Moodle 3.4. We intend to support all future Moodle releases. If your version of Moodle is not listed here please contact the developers: we probably simply have not done the testing of future versions yet. For longer support of older versions of Moodle please contact us, otherwise will will drop them from out list.
* Please ensure you have [installed Moodle](http://docs.moodle.org/en/Main_page). We intend to support STACK within the normal Moodle [release cycle](https://docs.moodle.org/dev/Releases). STACK 4.3 has been tested on Moodle 3.5, 3.6, 3.7 and 3.8. STACK is untested on versions before Moodle 3.4. We intend to support all future Moodle releases. If your version of Moodle is not listed here please contact the developers: we probably simply have not done the testing of future versions yet. For longer support of older versions of Moodle please contact us, otherwise will will drop them from our list.
* Please ensure LaTeX can be displayed. We currently support [MathJax](Mathjax.md) through the Moodle MathJax filter.
Consider updating the MathJax settings to [wrap long equations](http://docs.mathjax.org/en/latest/output.html?highlight=automatic%20line%20breaking#automatic-line-breaking). In particular, add
Consider updating the MathJax settings to wrap long equations. In particular, add
CommonHTML: { linebreaks: { automatic: true } },
"HTML-CSS": { linebreaks: { automatic: true } },
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment