Skip to content

Commit fb8d7f1

Browse files
README: minor polish (#52691)
changes - move `write_base_cache.jl` to `contrib/` `generate_precompile.jl` is also placed there - In section "Source Code Organization", add `etc/`, remove `usr/` `usr/` appears only at build time. - Some minor polish --------- Co-authored-by: Viral B. Shah <ViralBShah@users.noreply.github.com>
1 parent 0ea2b56 commit fb8d7f1

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ $(build_depsbindir)/stringreplace: $(JULIAHOME)/contrib/stringreplace.c | $(buil
185185

186186
julia-base-cache: julia-sysimg-$(JULIA_BUILD_MODE) | $(DIRS) $(build_datarootdir)/julia
187187
@JULIA_BINDIR=$(call cygpath_w,$(build_bindir)) JULIA_FALLBACK_REPL=1 WINEPATH="$(call cygpath_w,$(build_bindir));$$WINEPATH" \
188-
$(call spawn, $(JULIA_EXECUTABLE) --startup-file=no $(call cygpath_w,$(JULIAHOME)/etc/write_base_cache.jl) \
188+
$(call spawn, $(JULIA_EXECUTABLE) --startup-file=no $(call cygpath_w,$(JULIAHOME)/contrib/write_base_cache.jl) \
189189
$(call cygpath_w,$(build_datarootdir)/julia/base.cache))
190190

191191
# public libraries, that are installed in $(prefix)/lib

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ interactive prompt into which you can enter expressions for
7777
evaluation. You can read about [getting
7878
started](https://docs.julialang.org/en/v1/manual/getting-started/) in the manual.
7979

80-
**Note**: Although some system package managers provide Julia, such
80+
**Note**: Although some OS package managers provide Julia, such
8181
installations are neither maintained nor endorsed by the Julia
8282
project. They may be outdated, broken and/or unmaintained. We
8383
recommend you use the official Julia binaries instead.
@@ -90,7 +90,7 @@ Then, acquire the source code by cloning the git repository:
9090

9191
git clone https://github.com/JuliaLang/julia.git
9292

93-
and then use the command prompt to change into the resulting julia directory. By default you will be building the latest unstable version of
93+
and then use the command prompt to change into the resulting julia directory. By default, you will be building the latest unstable version of
9494
Julia. However, most users should use the [most recent stable version](https://github.com/JuliaLang/julia/releases)
9595
of Julia. You can get this version by running:
9696

@@ -117,7 +117,7 @@ started](https://docs.julialang.org/en/v1/manual/getting-started/)
117117
in the manual.
118118

119119
Detailed build instructions, should they be necessary,
120-
are included in the [build documentation](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/).
120+
are included in the [build documentation](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/build.md).
121121

122122
### Uninstalling Julia
123123

@@ -132,22 +132,22 @@ The Julia source code is organized as follows:
132132
| Directory | Contents |
133133
| - | - |
134134
| `base/` | source code for the Base module (part of Julia's standard library) |
135-
| `stdlib/` | source code for other standard library packages |
136135
| `cli/` | source for the command line interface/REPL |
137136
| `contrib/` | miscellaneous scripts |
138137
| `deps/` | external dependencies |
139138
| `doc/src/` | source for the user manual |
139+
| `etc/` | contains `startup.jl` |
140140
| `src/` | source for Julia language core |
141+
| `stdlib/` | source code for other standard library packages |
141142
| `test/` | test suites |
142-
| `usr/` | binaries and shared libraries loaded by Julia's standard libraries |
143143

144144
## Terminal, Editors and IDEs
145145

146146
The Julia REPL is quite powerful. See the section in the manual on
147147
[the Julia REPL](https://docs.julialang.org/en/v1/stdlib/REPL/)
148148
for more details.
149149

150-
On Windows we highly recommend running Julia in a modern terminal,
150+
On Windows, we highly recommend running Julia in a modern terminal,
151151
such as [Windows Terminal from the Microsoft Store](https://aka.ms/terminal).
152152

153153
Support for editing Julia is available for many
@@ -158,7 +158,7 @@ Support for editing Julia is available for many
158158
others.
159159

160160
For users who prefer IDEs, we recommend using VS Code with the
161-
[julia-vscode](https://www.julia-vscode.org/) plugin.
161+
[julia-vscode](https://www.julia-vscode.org/) plugin.
162162
For notebook users, [Jupyter](https://jupyter.org/) notebook support is available through the
163163
[IJulia](https://github.com/JuliaLang/IJulia.jl) package, and
164164
the [Pluto.jl](https://github.com/fonsp/Pluto.jl) package provides Pluto notebooks.
File renamed without changes.

0 commit comments

Comments
 (0)