Skip to content
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

Add instructions for helpless Ubuntu users like myself. #1533

Merged
merged 1 commit into from Mar 14, 2017

Conversation

AaronBallman
Copy link
Contributor

Getting started on Ubuntu turns out to be a bit more complex than just getting latexmk and running with it. Building the documentation fails without these other packages installed, so we might as well mention that.

README.rst Outdated
@@ -26,6 +26,14 @@ then run the following command to install the other packages that the draft requ

sudo tlmgr install latexmk isodate substr relsize ulem fixme rsfs extract layouts enumitem

-------------------------
Getting Started on Ubuntu
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this say "Debian" instead? Or "Debianesque systems"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could. I picked Ubuntu because that's what OS I experienced the issue on. I suppose it could say "Getting Started on Systems With apt-get"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AaronBallman: Yes. We call those systems "Debian" :-) (Or Debian-based.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to change it however you'd prefer. Would you like me to go with Debian-based or Debian?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "Debian-based" is good.

@AaronBallman
Copy link
Contributor Author

Okay, this should be set with the new title now.

@jwakely
Copy link
Member

jwakely commented Mar 13, 2017

FWIW the TeX packages I install on Fedora are:
texlive texlive-isodate texlive-relsize texlive-ulem texlive-fixme texlive-extract

@AaronBallman
Copy link
Contributor Author

Would you like me to add a Fedora section? If so, let me know what you'd like the title to be and what command you use to install those packages, and I'll add another section to the patch.

@burblebee
Copy link
Contributor

@AaronBallman Yes, please add Fedora info as well

@AaronBallman
Copy link
Contributor Author

AaronBallman commented Mar 13, 2017

Am I correct in understanding this would be:

sudo yum install <packages>

?

@burblebee
Copy link
Contributor

should be

@AaronBallman
Copy link
Contributor Author

I've updated the patch for Fedora as well.

@jwakely
Copy link
Member

jwakely commented Mar 13, 2017

No, yum is deprecated, dnf install blah blah but I don't think sudo is configured by default, so maybe use:

(as root) dnf install texlive texlive-isodate texlive-relsize texlive-ulem texlive-fixme texlive-extract

@AaronBallman
Copy link
Contributor Author

One more try, this time with dnf instead of yum.

@jwakely
Copy link
Member

jwakely commented Mar 13, 2017

Hrm, sorry to be a pain, now I look at it, it would probably be better to put the (as root) after "Fedora" not before the dnf command. Otherwise looks good to me. And I don't see any reason we can't merge this now, since it doesn't affect the actual draft.

@AaronBallman
Copy link
Contributor Author

I wasn't too keen on putting (as root) after Fedora, but I didn't mind putting it in the instructions. How does this look to you?

@tkoeppe
Copy link
Contributor

tkoeppe commented Mar 13, 2017

I wouldn't even necessarily say "as root" at all -- people should know how to use their system; if they're already in the business of installing packages, they probably know how to do it right.

@AaronBallman
Copy link
Contributor Author

I can certainly remove it, but we do show sudo in the other two examples, and it seems somewhat strange to leave it off for Fedora. As @jwakely pointed out, sudo is not configured by default, but perhaps we could still use it for this case as well (and assume people know how to configure sudo or drop into su manually)?

@tkoeppe
Copy link
Contributor

tkoeppe commented Mar 13, 2017

Yes, that's true, and we can keep it in, I don't mind. It was just an idea.

@burblebee
Copy link
Contributor

Why not do sudo here too?

README.rst Outdated

Install the following packages (as root):

dnf install texlive texlive-isodate texlive-relsize texlive-ulem texlive-fixme texlive-extract
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add sudo here to be consistent with Debian-based instructions

@AaronBallman
Copy link
Contributor Author

Added sudo and removed the (as root).

@jwakely
Copy link
Member

jwakely commented Mar 14, 2017

No, please don't add sudo to the Fedora instructions, because that doesn't work on Fedora. Fedora != Ubuntu. It's not set up so you can just bork your system by adding sudo (https://xkcd.com/149/)

By default any Ubuntu user can just add sudo to any command to run as root, and I assume that's true for OS X too. It's not true for Fedora.

As @jwakely pointed out, sudo is not configured by default, but perhaps we could still use it for this case as well (and assume people know how to configure sudo or drop into su manually)?

Instead of assuming they know how to modify their sudoers config, let's just not include sudo in the command, so if they have configured sudo to let it work, they will know to add sudo, and if not they'll know to use su.

I'm fine with just dropping the "(as root)" part and assuming Fedora users building the standard know how to install packages, but a command that doesn't work is not helpful. I'd rather not mention Fedora at all than have a command that won't work.

@AaronBallman
Copy link
Contributor Author

Updated to remove the sudo command for Fedora.

@burblebee burblebee merged commit e3214d7 into cplusplus:master Mar 14, 2017
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.

None yet

4 participants