Skip to content

Commit

Permalink
Docs updates and corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
magistere committed Nov 8, 2013
1 parent f81aa2a commit 7b1d0be
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Hi! Thanks for checking out Julia. If you have questions or problems, the [Julia

### Contributing a Julia package

Julia has a built-in [package manager](https://github.com/JuliaLang/METADATA.jl) based on git. A number of [packages](http:https://docs.julialang.org/en/latest/packages/packagelist/) across many domains are already available for julia. Developers are encouraged to provide their libraries as a Julia package. The Julia manual provides instructions on [creating julia packages](http:https://docs.julialang.org/en/latest/manual/packages/).
Julia has a built-in [package manager](https://github.com/JuliaLang/METADATA.jl) based on git. A number of [packages](http:https://docs.julialang.org/en/latest/packages/packagelist/) across many domains are already available for Julia. Developers are encouraged to provide their libraries as a Julia package. The Julia manual provides instructions on [creating Julia packages](http:https://docs.julialang.org/en/latest/manual/packages/).

For developers who need to wrap C libraries so that they can be called from Julia, the [Clang.jl](https://github.com/ihnorton/Clang.jl) package can help generate the wrappers automatically from the C header files.

Expand Down
12 changes: 6 additions & 6 deletions DISTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ installation. If you wish to create a distribution package such as a
for an example of what metadata is needed for creating `.deb` packages
for Debian and Ubuntu-based systems. Although we have not yet experimented
with it, [Alien](https://wiki.debian.org/Alien) could be used to
generate Julia packages for various linux distributions.
generate Julia packages for various Linux distributions.

Julia looks for git versioning information when building. If it does
not find the git executable or the `.git/` directory is unreadable,
the build process will continue, however all versioning information
will be unavailable. This is the case, for instance, on canonical's
`buildd` servers where the [Ubuntu
will be unavailable. This is the case, for instance, on Canonical's
build servers where the [Ubuntu
nightlies](https://launchpad.net/~staticfloat/+archive/julianightlies)
are built. Therefore, a workaround must be enacted, where the git
versioning information [is encoded into the
Expand All @@ -50,7 +50,7 @@ By default, Julia loads `$PREFIX/etc/julia/juliarc.jl` as an
installation-wide initialization file. This file can be used by
distribution managers to provide paths to various binaries such as a
bundled `git` executable (as we do on OS X), or to setup paths (as
we do on Windows). For linux distribution packages, if `$PREFIX` is
we do on Windows). For Linux distribution packages, if `$PREFIX` is
set to `/usr`, there is no `/usr/etc` to look into. This requires
the path to Julia's private `etc` directory to be changed. This can
be done via the `SYSCONFDIR` make variable when building. Simply
Expand Down Expand Up @@ -78,10 +78,10 @@ Windows
-------

The best supported method of creating a Julia distribution on Windows
is to cross-compile from a linux distribution such as Ubuntu. Indepth
is to cross-compile from a Linux distribution such as Ubuntu. In-depth
compilation instructions [are
available](https://github.com/JuliaLang/julia/blob/master/README.windows.md).
However the important steps for redistrubition are to ensure to `make
However the important steps for redistribution are to ensure to `make
win-extras` in between `make` and `make dist`. After that process is
completed, the `.zip` file created in the head Julia directory will
hold a completely self-contained Julia.
Expand Down
4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Julia is licensed under the MIT License:

> Copyright (c) 2009-2012: Jeff Bezanson, Stefan Karpinski, Viral B. Shah,
> Copyright (c) 2009-2013: Jeff Bezanson, Stefan Karpinski, Viral B. Shah,
> and other contributors:
>
> https://github.com/JuliaLang/julia/contributors
Expand All @@ -27,7 +27,7 @@ Julia is licensed under the MIT License:
[`repl-readline.c`](https://github.com/JuliaLang/julia/blob/master/ui/repl-readline.c)
is licensed under the GNU General Public License Version 2:

> Copyright (c) 2009-2012: Jeff Bezanson, Stefan Karpinski, Viral B. Shah.
> Copyright (c) 2009-2013: Jeff Bezanson, Stefan Karpinski, Viral B. Shah.
>
> This program is free software; you can redistribute it and/or modify
> it under the terms of the GNU General Public License as published by
Expand Down
4 changes: 2 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Library improvements
to account for this increased strictness.

* A redesigned and rewritten `Pkg` system is much more robust in case of problems.
The the basic interface to adding and removing package requirements remains the
The basic interface to adding and removing package requirements remains the
same, but great deal of additional functionality for developing packages in-place
was added. See the new [packages chapter] in the manual for further details.

Expand All @@ -161,7 +161,7 @@ Library improvements

* Change `integer_valued`, `real_valued`, and so on to `isinteger`, `isreal`,
and so on, and semantics of the later are now value-based rather than type-based,
unlike Matlab/Octave ([#3071]). `isbool` and `iscomplex` are eliminated in favor
unlike MATLAB/Octave ([#3071]). `isbool` and `iscomplex` are eliminated in favor
of a general `iseltype` function.

* Transitive comparison of floats with rationals ([#3102]).
Expand Down
6 changes: 3 additions & 3 deletions README.windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Binary Downloads

Download the latest version of Julia from the downloads page at http:https://julialang.org/downloads/

Unzip the download to a folder. Do not attempt to run Julia without extracting the zip archive first (hint: it won't work). Double-click the file Julia.BAT to launch Julia.
Unzip the download to a folder. Do not attempt to run Julia without extracting the zip archive first (hint: it won't work). Double-click the file `julia.bat` to launch Julia.

Explore and have fun!

Expand Down Expand Up @@ -63,7 +63,7 @@ Before proceeding, verify that python.exe from Python 2.7 is available in the MS

If you plan to build Cairo (for graphics), you'll also need to install [CMake](http:https://www.cmake.org/cmake/resources/software.html).

These sections assume you are familiar with building code. If you are not, you should stop reading now and go the the section on binaries. Regardless of which set of steps you followed above, you are now ready to compile julia. Open a unix shell by launching C:/MinGW/msys/1.0/msys.bat (or your favorite shortcut to that file).
These sections assume you are familiar with building code. If you are not, you should stop reading now and go to the section on binaries. Regardless of which set of steps you followed above, you are now ready to compile julia. Open a unix shell by launching C:/MinGW/msys/1.0/msys.bat (or your favorite shortcut to that file).

Run the following commands in your build directory ($HOME at C:/MinGW/msys/1.0/home/your_name is fine)

Expand All @@ -74,7 +74,7 @@ Run the following commands in your build directory ($HOME at C:/MinGW/msys/1.0/h
Running julia can be done in two ways:

1. `make run-julia[-release|-debug] [DEFAULT_REPL=(basic|readline)]` (e.g. `make run-julia`)
2. Launching the julia.bat script in usr/bin
2. Launching the `julia.bat` script in usr/bin

Cross-Compile
-------------
Expand Down

0 comments on commit 7b1d0be

Please sign in to comment.