Browse Source

Updated README to provide pandoc version requirements

nitrocode 6 years ago
parent
commit
95f8ac0ce3
1 changed files with 28 additions and 3 deletions
  1. 28 3
      README.md

+ 28 - 3
README.md

@@ -19,10 +19,14 @@ docker-compose up -d
 
 
 ### Requirements
 ### Requirements
 
 
- * ConTeXt
- * pandoc
+* ConTeXt 0.6X
+* pandoc 2.x
+    * 1.x is deprecated
+
+Last tested on the above versions and that's not to say the later versions won't work. Please try to use the latest versions when possible.
+
+#### Debian / Ubuntu
 
 
-#### Debian
 ```bash
 ```bash
 sudo apt install pandoc context
 sudo apt install pandoc context
 ```
 ```
@@ -47,6 +51,27 @@ sh ./first-setup.sh --modules=all --engine=luatex
 ```
 ```
 
 
 ### Troubleshooting
 ### Troubleshooting
+
+#### Get versions
+
+Check if the dependencies are up to date.
+
+```
+context --version
+pandoc --version
+```
+
+#### Cannot process lua
+Currently pandoc 1.x may be within your distro's repos and the latest version should be used. See the
+[pandoc releases](https://github.com/jgm/pandoc/releases) for your distro.
+
+e.g. for Debian / Ubuntu
+```
+wget https://github.com/jgm/pandoc/releases/download/2.2.1/pandoc-2.2.1-1-amd64.deb
+sudo dpkg -i pandoc-2.2.1-1-amd64.deb
+```
+
+#### Context executable cannot be found
 Some users have reported problems where their system does not properly find the ConTeXt
 Some users have reported problems where their system does not properly find the ConTeXt
 executable, leading to errors like `Cannot find context.lua` or similar. It has been found
 executable, leading to errors like `Cannot find context.lua` or similar. It has been found
 that running `mtxrun --generate`, (as suggested at
 that running `mtxrun --generate`, (as suggested at