Skip to content

document building with vcpkg #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from Aug 29, 2019
Merged

document building with vcpkg #451

merged 3 commits into from Aug 29, 2019

Conversation

ghost
Copy link

@ghost ghost commented Aug 27, 2019

Document how to use vcpkg to build tectonic on macOS.
Adapted the details from #420.

@pkgw
Copy link
Collaborator

pkgw commented Aug 27, 2019

Thanks! The CI is complaining because you need to add a language specifier to the code blocks to prevent mdbook test from trying to compile them as Rust, like here.

@pkgw
Copy link
Collaborator

pkgw commented Aug 27, 2019

Also ... I am kind of old-fashioned and prefer hard linewraps at ~80 characters. Would one of those .editorconfig files encourage people's tools to do that kind of wrapping?

@ghost
Copy link
Author

ghost commented Aug 27, 2019

Ah, thanks, I'll fix that.
editorconfig is only for indentation and trailing white space I think.
We could explore a markdown linter or another kind of tool to enforce that.

@ghost
Copy link
Author

ghost commented Aug 27, 2019

Although they do have some research on the topic: https://github.com/editorconfig/editorconfig/wiki/Property-research:-maximum-line-length

@codecov
Copy link

codecov bot commented Aug 27, 2019

Codecov Report

Merging #451 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #451      +/-   ##
==========================================
+ Coverage   45.54%   45.55%   +<.01%     
==========================================
  Files         138      138              
  Lines       59814    59814              
==========================================
+ Hits        27244    27246       +2     
+ Misses      32570    32568       -2
Impacted Files Coverage Δ
tectonic/dpx-pdfobj.c 46.55% <0%> (+0.12%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fe9aaa0...78cd3fe. Read the comment docs.

@ghost
Copy link
Author

ghost commented Aug 27, 2019

I've worked with prettier but think that is overkill here.
We could consider using remark-lint to enforce the maximum length. Their rule document is here.

`prettier --prose-wrap always --print-width 80 --write docs/src/cookbook/vcpkg.md` mostly worked, but removed indenting for some code blocks which I manually restored.
@pkgw
Copy link
Collaborator

pkgw commented Aug 29, 2019

Thanks for researching linters while you're at it!

FWIW I think I'd ideally like to have this text in a section of the book named Installation or Development (or maybe Contributing?), but as I wrote before, I think it's best to get text in first and rearrange later. I guess my current thinking is that Getting Started should have a Quick Installation section, which should point to an Installation document with less-common cases.

@pkgw pkgw self-assigned this Aug 29, 2019
@ghost
Copy link
Author

ghost commented Aug 29, 2019

Certainly!
I think Installation or Development would be helpful sections. I would want to migrate the other description of how to build a static binary using docker to that section as well.
I also think we could move the fuzzing guide there as well.

@pkgw pkgw merged commit f8b1590 into tectonic-typesetting:master Aug 29, 2019
@ghost ghost deleted the document-static-build branch August 29, 2019 23:29
@ghost
Copy link
Author

ghost commented Sep 10, 2019

In the spirit of being a Rust project, textwrap in a simple CLI would be great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants