move build instructions from wiki to source root #960
Conversation
…ium#958 wiki pages: version d0b60c4094b424de91e91846ea9a0818d183df18 - linux build dependencies - compiling on linux - compiling macos - compiling windows - RPi - code testing
|
There are some hyperlinks esp. in the RaspberryPi part. These should no longer point to external .md files. Either change to in-doc hyperlinks, or (if that is not available) into phrases like "see ... above". |
| You may want to install a swap file, otherwise you may run out of virtual memory when compiling | ||
| [https://www.cyberciti.biz/faq/linux-add-a-swap-file-howto/](https://www.cyberciti.biz/faq/linux-add-a-swap-file-howto/) | ||
|
|
||
| Then, make sure to install the [build requirements](#lbuild-dependencies) and follow the [building instructions for Linux](#linux). |
There was a problem hiding this comment.
I randomly clicked on a few hyperlinks in an MD editor. This failed, program crashed.
There was a problem hiding this comment.
ok. what editor was that, please?
There was a problem hiding this comment.
it's possibly the GMD syntax that gives this issue.
There was a problem hiding this comment.
"Markdown Editor" by Poppen's Lab, my first usable contact with MD. I accept recommendations for better tools as long as they are free.
|
To be honest, I don't use a Mardown editor (and a dev will just browse the text or browse the GitHub page). Often there are good plugins for IDE's: for example in PyCharm the links works fine.
I couldn't find that editor yet. (I haven't set up a good Stellarium dev environment yet to evaluate markdown plugins.) |
|
@gzotti |
|
In the last weeks other things were more important than where to place build instructions. Of course there should only be one place. If we combine all docs to one, who shall go through the text and reduce e.g. git duplicates or harmonize instructions? E.g. Raspberry notes may be a part of Linux. |
|
Just copying few documents into one big document is not very good solution. For example you are wrote in the first paragraph:
and in paragraph 15 (Qt versions) user may see:
Seriously? You proposed moving and restructure the building instruction for offline usage and those instructions should be actual. Sorry, but this version of instructions is not actual. If you began using Qt 5.5 for Linux as example, then you need use same version for macOS and Windows too. At the moment minimal version Qt for building master version of Stellarium is 5.6.0, but we recommended using Qt 5.9 or, better, Qt 5.12 (both - LTS) for building planetarium. Other problem: the BUILDING.md file missing important part for building the binary package from source code - configuration options - http://stellarium.sourceforge.net/wiki/index.php/Configuring_Build_Options Yes, the list of options is not actual now and it should be revised. Of course part of instructions, who related to Raspberry Pi need move to Linux block with remarks. Many parts of text are redundant by historical reasons and it should be revised too - so, final document need editing and proofreading! |
|
PLEASE! I cannot
I have no vision on everything that changed, and cannot know it completely. Can we PLEASE split this into TWO steps:
by blocking this PR because the instructions are outdated is a bad idea, this will never close this issue. I never proposed to UPDATE the instructions. |
|
All I write is
|
|
I think this is also superseded and can be closed. |
Ensure code build instructions closely follow source root changes.
Description
Replaces wiki pages
Fixes #958