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

WIP: Refactoring of README.md #31858

Merged
merged 6 commits into from
Apr 29, 2019
Merged

WIP: Refactoring of README.md #31858

merged 6 commits into from
Apr 29, 2019

Conversation

ViralBShah
Copy link
Member

The idea is to have only the default instructions that are we would like to just work in the top-level README, and move the detailed build and install instructions into a separate file.

I will be further refactoring the INSTALL.md and the various other platform specific READMEs.

@ViralBShah ViralBShah added the domain:docs This change adds or pertains to documentation label Apr 27, 2019
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@musm
Copy link
Contributor

musm commented Apr 28, 2019

I think required build tools section may also be moved to INSTALL.md

@ViralBShah
Copy link
Member Author

ViralBShah commented Apr 29, 2019

I think required build tools is good to have right here, because it is a pre-requisite that is immediately useful to someone typing make.

I guess with BinaryBuilder, the actual list is much smaller. So the full list could go to INSTALL.md, and have something smaller here.

@StefanKarpinski
Copy link
Sponsor Member

Maybe call it BUILD.md instead of INSTALL.md since it’s about how to build Julia from source whereas there are other ways to install (eg binary install).

@musm
Copy link
Contributor

musm commented Apr 29, 2019

I would also move up Binary Installation above Source Code Organization, so that it comes right after Source Download and Compilation , since that is a more logical ordering.

README.md Outdated Show resolved Hide resolved
@ViralBShah ViralBShah merged commit a13c2cd into master Apr 29, 2019
@fredrikekre fredrikekre deleted the vs/readme branch April 30, 2019 05:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants