search

linuxmint / doc-developer-guide

The Linux Mint Developer Guide
20 stars 18 forks source link

Update build instructions in the README file #23

Closed h3nr1ke closed 3 months ago

h3nr1ke commented 4 months ago

Hello,

this will add more information to build the documentation. I tried it my self in a fresh mint installation.

Hope it helps other to build and contribute

this PR address the issue #4

mtwebster commented 3 months ago

I'm really not crazy about providing pip instructions here - mixing pip packages with system packages can cause broken apps.

We can remove it, or maybe a firm warning for the pip instructions to only do this in a virtual environment.

h3nr1ke commented 3 months ago

Hey @mtwebster thanks for taking time to review it

What about add ths disclaimer like this one

Alternatively, you can use pip3 to complete the process, but pay attention that this should be done only if you are in a virtual environment.

What to do you think?

mtwebster commented 3 months ago

Sorry, missed your response, that's fine

h3nr1ke commented 3 months ago

Hey @mtwebster, no problem

I just did the update =)