From d5c5a43f67b6c8c38f125704ca29c033ff8ff77f Mon Sep 17 00:00:00 2001 From: m-j-w Date: Sun, 26 Mar 2017 09:55:32 +0200 Subject: [PATCH 1/2] Move manual anchors in README.md below headlines. Alternative approach to make GitHub correctly render the `README.md` headlines by simply moving the manual anchors to below the headlines. Since current manual anchors are uppercase, this keeps external links valid. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 43e19ece0f37e..bb2183f51aa99 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,15 @@ Windows: [![Build status](https://ci.appveyor.com/api/projects/status/dvial98s5v Code Coverage: [![Coverage Status](https://coveralls.io/repos/JuliaLang/julia/badge.svg?branch=master)](https://coveralls.io/r/JuliaLang/julia?branch=master) [![codecov.io](http://codecov.io/github/JuliaLang/julia/coverage.svg?branch=master)](http://codecov.io/github/JuliaLang/julia?branch=master) - ## The Julia Language + Julia is a high-level, high-performance dynamic language for technical computing. The main homepage for Julia can be found at [julialang.org](http://julialang.org/). This is the GitHub repository of Julia source code, including instructions for compiling and installing Julia, below. - ## Resources + - **Homepage:** - **Binaries:** @@ -43,8 +43,8 @@ New developers may find the notes in [CONTRIBUTING](https://github.com/JuliaLang - [**Twitter**](https://twitter.com/JuliaLanguage) - [**Meetup**](http://julia.meetup.com/) - ## Currently Supported Platforms + - **Linux** - **MacOS** @@ -53,8 +53,8 @@ New developers may find the notes in [CONTRIBUTING](https://github.com/JuliaLang All systems are supported with both x86/64 (64-bit) and x86 (32-bit, except MacOS) architectures. Support for [ARM](https://github.com/JuliaLang/julia/blob/master/README.arm.md), AARCH64, and POWER8 (little-endian) has been added recently. - ## Source Download and Compilation + First, make sure you have all the [required dependencies](#Required-Build-Tools-External-Libraries) installed. Then, acquire the source code by cloning the git repository: @@ -171,13 +171,13 @@ latest version. - ## Uninstalling Julia + Julia does not install anything outside the directory it was cloned into. Julia can be completely uninstalled by deleting this directory. Julia packages are installed in `~/.julia` by default, and can be uninstalled by deleting `~/.julia`. - ## Platform-Specific Build Notes + ### Linux @@ -255,8 +255,8 @@ In order to build Julia on Windows, see [README.windows](https://github.com/Juli Julia can be developed in an isolated Vagrant environment. See [the Vagrant README](https://github.com/JuliaLang/julia/blob/master/contrib/vagrant/README.md) for details. - ## Required Build Tools and External Libraries + Building Julia requires that the following software be installed: @@ -333,8 +333,8 @@ Julia uses the following external libraries, which are automatically downloaded [mbedtls]: https://tls.mbed.org/ [pkg-config]: https://www.freedesktop.org/wiki/Software/pkg-config/ - ### System Provided Libraries + If you already have one or more of these packages installed on your system, you can prevent Julia from compiling duplicates of these libraries by passing `USE_SYSTEM_...=1` to `make` or adding the line to `Make.user`. The complete list of possible flags can be found in `Make.inc`. @@ -365,8 +365,8 @@ Add the following to the `Make.user` file: It is highly recommended to start with a fresh clone of the Julia repository. - ## Source Code Organization + The Julia source code is organized as follows: @@ -382,8 +382,8 @@ The Julia source code is organized as follows: ui/ source for various front ends usr/ binaries and shared libraries loaded by Julia's standard libraries - ## Binary Installation + If you would rather not compile the latest Julia from source, platform-specific tarballs with pre-compiled binaries are also [available for download](http://julialang.org/downloads/). @@ -420,8 +420,8 @@ The following distributions include julia, but the versions may be out of date d * [MacPorts](https://trac.macports.org/browser/trunk/dports/lang/julia/Portfile) * [OS X Homebrew Tap](https://github.com/staticfloat/homebrew-julia/) - ## Editor and Terminal Setup + Currently, Julia editing mode support is available for a number of editors. While Julia modes for From 6ba0b7d87358fdabfe48cfa0f546474126d2a431 Mon Sep 17 00:00:00 2001 From: m-j-w Date: Sun, 26 Mar 2017 09:15:41 +0200 Subject: [PATCH 2/2] Remove manual HTML anchors from README.md. The `README.md` is currently rendered incorrectly on GitHub since it includes manual HTML anchors for headlines. However, since several years, GitHub automatically includes these anchors. Considering the anchors in the README.md have been added some six years ago, the GitHub feature is probably younger. This removes all the manual anchors, for which all match the exact headline pattern anyway, except the following which differ slightly: - `` - `` - `` If referenced from somewher externally, these would need to be updated. Links within this README to anchors are also corrected. The automatically generated anchors on GitHub follow the pattern of replacing all spaces with `-` and everything being lowercase, e.g. `## This is a Title` automatically gets the anchor equivalent to `` to be referenced in markdown with `[Link to a title](#this-is-a-title)`. --- README.md | 20 ++++---------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index bb2183f51aa99..05c022f575aee 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,12 @@ Windows: [![Build status](https://ci.appveyor.com/api/projects/status/dvial98s5v Code Coverage: [![Coverage Status](https://coveralls.io/repos/JuliaLang/julia/badge.svg?branch=master)](https://coveralls.io/r/JuliaLang/julia?branch=master) [![codecov.io](http://codecov.io/github/JuliaLang/julia/coverage.svg?branch=master)](http://codecov.io/github/JuliaLang/julia?branch=master) ## The Julia Language - Julia is a high-level, high-performance dynamic language for technical computing. The main homepage for Julia can be found at [julialang.org](http://julialang.org/). This is the GitHub repository of Julia source code, including instructions for compiling and installing Julia, below. ## Resources - - **Homepage:** - **Binaries:** @@ -36,7 +34,6 @@ This is the GitHub repository of Julia source code, including instructions for c New developers may find the notes in [CONTRIBUTING](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md) helpful to start contributing to the Julia codebase. ### External Resources - - [**StackOverflow**](https://stackoverflow.com/questions/tagged/julia-lang) - [**Youtube**](https://www.youtube.com/channel/UC9IuUwwE2xdjQUT_LMLONoA) @@ -44,7 +41,6 @@ New developers may find the notes in [CONTRIBUTING](https://github.com/JuliaLang - [**Meetup**](http://julia.meetup.com/) ## Currently Supported Platforms - - **Linux** - **MacOS** @@ -54,9 +50,8 @@ New developers may find the notes in [CONTRIBUTING](https://github.com/JuliaLang All systems are supported with both x86/64 (64-bit) and x86 (32-bit, except MacOS) architectures. Support for [ARM](https://github.com/JuliaLang/julia/blob/master/README.arm.md), AARCH64, and POWER8 (little-endian) has been added recently. ## Source Download and Compilation - -First, make sure you have all the [required dependencies](#Required-Build-Tools-External-Libraries) installed. +First, make sure you have all the [required dependencies](#required-build-tools-and-external-libraries) installed. Then, acquire the source code by cloning the git repository: git clone git://github.com/JuliaLang/julia.git @@ -72,7 +67,7 @@ By default you will be building the latest unstable version of Julia. However, m git checkout release-0.5 Now run `make` to build the `julia` executable. To perform a parallel build, use `make -j N` and supply the maximum number of concurrent processes. (See [Platform Specific Build Notes](https://github.com/JuliaLang/julia#platform-specific-build-notes) for details.) -When compiled the first time, it will automatically download and build its [external dependencies](#Required-Build-Tools-External-Libraries). +When compiled the first time, it will automatically download and build its [external dependencies](#required-build-tools-and-external-libraries). This takes a while, but only has to be done once. If the defaults in the build do not work for you, and you need to set specific make parameters, you can save them in `Make.user`. The build will automatically check for the existence of `Make.user` and use it if it exists. Building Julia requires 1.5GiB of disk space and approximately 700MiB of virtual memory. @@ -172,12 +167,10 @@ latest version. ## Uninstalling Julia - Julia does not install anything outside the directory it was cloned into. Julia can be completely uninstalled by deleting this directory. Julia packages are installed in `~/.julia` by default, and can be uninstalled by deleting `~/.julia`. ## Platform-Specific Build Notes - ### Linux @@ -186,7 +179,7 @@ Julia does not install anything outside the directory it was cloned into. Julia * GCC version 4.7 or later is required to build Julia. * To use external shared libraries not in the system library search path, set `USE_SYSTEM_XXX=1` and `LDFLAGS=-Wl,-rpath,/path/to/dir/contains/libXXX.so` in `Make.user`. * Instead of setting `LDFLAGS`, putting the library directory into the environment variable `LD_LIBRARY_PATH` (at both compile and run time) also works. -* See also the [external dependencies](#Required-Build-Tools-External-Libraries). +* See also the [external dependencies](#required-build-tools-and-external-libraries). #### Architecture Customization @@ -199,7 +192,7 @@ You can also set `MARCH=native` for a maximum-performance build customized for t #### Ubuntu -The [julia-deps PPA](https://launchpad.net/~staticfloat/+archive/julia-deps/) contains updated packages for Julia dependencies if you want to use system libraries instead of having them downloaded and built during the build process. See [System Provided Libraries](#System-Provided-Libraries). +The [julia-deps PPA](https://launchpad.net/~staticfloat/+archive/julia-deps/) contains updated packages for Julia dependencies if you want to use system libraries instead of having them downloaded and built during the build process. See [System Provided Libraries](#system-provided-libraries). #### RHEL/CentOS 6 @@ -256,7 +249,6 @@ In order to build Julia on Windows, see [README.windows](https://github.com/Juli Julia can be developed in an isolated Vagrant environment. See [the Vagrant README](https://github.com/JuliaLang/julia/blob/master/contrib/vagrant/README.md) for details. ## Required Build Tools and External Libraries - Building Julia requires that the following software be installed: @@ -334,7 +326,6 @@ Julia uses the following external libraries, which are automatically downloaded [pkg-config]: https://www.freedesktop.org/wiki/Software/pkg-config/ ### System Provided Libraries - If you already have one or more of these packages installed on your system, you can prevent Julia from compiling duplicates of these libraries by passing `USE_SYSTEM_...=1` to `make` or adding the line to `Make.user`. The complete list of possible flags can be found in `Make.inc`. @@ -366,7 +357,6 @@ Add the following to the `Make.user` file: It is highly recommended to start with a fresh clone of the Julia repository. ## Source Code Organization - The Julia source code is organized as follows: @@ -383,7 +373,6 @@ The Julia source code is organized as follows: usr/ binaries and shared libraries loaded by Julia's standard libraries ## Binary Installation - If you would rather not compile the latest Julia from source, platform-specific tarballs with pre-compiled binaries are also [available for download](http://julialang.org/downloads/). @@ -421,7 +410,6 @@ The following distributions include julia, but the versions may be out of date d * [OS X Homebrew Tap](https://github.com/staticfloat/homebrew-julia/) ## Editor and Terminal Setup - Currently, Julia editing mode support is available for a number of editors. While Julia modes for