Browse Source

Merge pull request #48 from nitrocode/latest-version-pandoc

Updated README to provide pandoc version requirements
Mark Szepieniec 6 years ago
parent
commit
334ab5d086
1 changed files with 31 additions and 9 deletions
  1. 31 9
      README.md

+ 31 - 9
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
 ```
 ```
@@ -40,15 +44,33 @@ sudo pacman -S pandoc texlive-core
 #### OSX
 #### OSX
 ```bash
 ```bash
 brew install pandoc
 brew install pandoc
-mkdir $HOME/context
-cd $HOME/context
-rsync -av rsync://contextgarden.net/minimals/setup/first-setup.sh .
-sh ./first-setup.sh --modules=all --engine=luatex
+brew cask install mactex
 ```
 ```
 
 
 ### 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
-https://tex.stackexchange.com/questions/53892/texlive-2011-context-problem), can fix the
+that running `mtxrun --generate`, ([suggested on texlive-2011-context-problem](
+https://tex.stackexchange.com/questions/53892/texlive-2011-context-problem)), can fix the
 issue.
 issue.