openmainframeproject / openmainframeproject/cobol-programming-course
Changes to README.md's Build section
Nobody has claimed this yet.
- Dominant language
- COBOL
- Stars
- 3.6k
- Forks
- 721
- Avg merge
- 11d 16h
- Merged PRs (30d)
- 1
Description
Course Details
GitHub
Description
Existing:
pandoc "COBOL Programming Course #1 - Getting Started.md" -o "COBOL Programming Course #1 - Getting Started.pdf" --number-sections --toc -B Front_Matter.tex --listings
Should read:
- unzip the file you download from git. be in this subdirectory "COBOL Programming Course#1 - Getting Started"
pandoc "COBOL Programming Course #1 - Getting Started.md" -o "COBOL Programming Course #1 - Getting Started.pdf" --number-sections --toc -B Front_Matter.tex --syntax-highlighting=idiomatic --pdf-engine="[path to pdflatex.exe]"
Front_Matter.tex contains the content before the table of contents. COBOL Programming Course #1 - Getting Started.md contains the body. The command combines the two as well as the .png images, generates the section numbers and table of contents for the body, and outputs COBOL Programming Course #1 - Getting Started.pdf
---- THE ABOVE SHOULD BE APPLIED ACCORDINGLY TO THE README.md's for Courses #2, #3, #4. ----
Reproduction Steps
- just look at the current README.md's (they essentially need to be updated for changes to pandoc)
...
Additional Context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the Build sections in the README.md files for Courses #1, #2, #3, and #4. Update the instructions and pandoc commands to reflect the requested subdirectory, syntax highlighting, and PDF engine options, then verify that all four README files are consistent and accurately describe the output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- latex, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100