deoren / fgw-playpen-library

Unofficial copy of the FGW Library (aka "Playpen") from Francis Glassborow's C++ Books
Other
3 stars 2 forks source link

Migrate wiki documentation #5

Open deoren opened 5 years ago

deoren commented 5 years ago

Drop into a Markdown "docs" file in order to bundle notes alongside the code.

Current wiki notes:

deoren commented 5 years ago

I began the process, but still have a good bit to do (and limited time to complete the work).

Scratch notes below from an Ubuntu 18.04 LTS x64 test box. Not shown here is me opening a text editor and pasting/saving the raw text from the linked MediaWiki page as youcandoit.wiki.txt.

  1. sudo apt-get update && sudo apt-get install -y lxd lxd-client lxd-tools criu
  2. lxc launch ubuntu:18.04 mediawiki-convert-test
  3. lxc file push youcandoit.wiki.txt mediawiki-convert-test/home/ubuntu/
  4. lxc exec mediawiki-convert-test -- sudo --login --user ubuntu
  5. sudo apt-get update && sudo apt-get install -y pandoc git texlive-latex-recommended texlive-xetex
  6. pandoc -f mediawiki -t markdown input.txt -o youcandoit.md
  7. exit
  8. lxc file pull mediawiki-convert-test/home/ubuntu/youcandoit.md .

I've added both the original text and the markdown converted file to a new branch, but haven't spent the needed time yet to clean up the output file (though it's already a good start in that direction).