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

Update README clarify build from command line #46290

Merged
merged 1 commit into from
Aug 9, 2022

Conversation

artkuo
Copy link
Contributor

@artkuo artkuo commented Aug 9, 2022

I fixed a few minor ambiguities in README:

  1. Added explicit instruction to change into julia directory. This was previously conflated with checkout of latest release, but clearer to separate the two, since everyone needs to be in that directory regardless of whether they did a checkout.
  2. Changed "from your Julia directory" to "change into the resulting julia directory" to make it clearer what directory is referred to. Changed upper- to lower-case to be consistent with subsequent references in README.
  3. Rewrote instruction for make so that it assumes/clarifies user should already be in julia directory.
  4. Same for ./julia because user should already be in directory.
  5. Removed "source" from "the julia source directory" because make testall should be executed from the same julia directory, and should not be confused with src.
    I have followed my updated instructions and verified that they work for myself.

I fixed a few minor ambiguities in README:
1.  Added a separate instruction to change into julia directory. It was conflated with checkout of latest release, but clearer to separate the two, since everyone needs to be in that directory regardless of whether they did a checkout.
2. Changed "from your Julia directory" to "change into the resulting julia directory" to make it clearer what directory is referred to. Changed upper- to lower-case to be consistent with subsequent references in README.  
3.  Rewrote instruction for `make` so that it assumes/clarifies user should already be in julia directory.
4.  Same for `./julia` because user should already be in directory. 
5. Removed "source" from "the julia source directory" because `make testall` should be executed from the same julia directory, and should not be confused with `src`.
I have followed my updated instructions and verified that they work for myself.
@ViralBShah ViralBShah merged commit cc9b5fb into JuliaLang:master Aug 9, 2022
@ViralBShah ViralBShah added the domain:docs This change adds or pertains to documentation label Aug 9, 2022
ffucci pushed a commit to ffucci/julia that referenced this pull request Aug 11, 2022
I fixed a few minor ambiguities in README:
1.  Added a separate instruction to change into julia directory. It was conflated with checkout of latest release, but clearer to separate the two, since everyone needs to be in that directory regardless of whether they did a checkout.
2. Changed "from your Julia directory" to "change into the resulting julia directory" to make it clearer what directory is referred to. Changed upper- to lower-case to be consistent with subsequent references in README.  
3.  Rewrote instruction for `make` so that it assumes/clarifies user should already be in julia directory.
4.  Same for `./julia` because user should already be in directory. 
5. Removed "source" from "the julia source directory" because `make testall` should be executed from the same julia directory, and should not be confused with `src`.
I have followed my updated instructions and verified that they work for myself.
pcjentsch pushed a commit to pcjentsch/julia that referenced this pull request Aug 18, 2022
I fixed a few minor ambiguities in README:
1.  Added a separate instruction to change into julia directory. It was conflated with checkout of latest release, but clearer to separate the two, since everyone needs to be in that directory regardless of whether they did a checkout.
2. Changed "from your Julia directory" to "change into the resulting julia directory" to make it clearer what directory is referred to. Changed upper- to lower-case to be consistent with subsequent references in README.  
3.  Rewrote instruction for `make` so that it assumes/clarifies user should already be in julia directory.
4.  Same for `./julia` because user should already be in directory. 
5. Removed "source" from "the julia source directory" because `make testall` should be executed from the same julia directory, and should not be confused with `src`.
I have followed my updated instructions and verified that they work for myself.
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

2 participants