Commit graph

56 commits

Author SHA1 Message Date
bors 3231fd3e65 Auto merge of #5381 - dwijnand:github-casing, r=alexcrichton
Fix how GitHub is written

just a silly PR - I noticed it in the README, and applied it repo-wide.
2018-04-18 01:47:40 +00:00
Dale Wijnand 2b2e726c26
typo 2018-04-17 22:15:34 +02:00
Dale Wijnand 43914c535b
Fix how GitHub is written 2018-04-17 22:15:27 +02:00
xftroxgpx e2f81ec879 Closes #5165 2018-03-11 23:09:57 +01:00
Matthias Krüger ddffe6063c readme: add link to the cargo documentation on docs.rs 2018-02-12 21:04:06 +01:00
Stefan Birkner 43ff35f7ff
Fix link to documentation 2018-02-07 23:36:54 +01:00
Bianca Nenciu 2547b0592a
Improved README. 2017-10-31 22:37:45 +02:00
lukaslueg 3970ccd235 Update README.md
Table is outdated and of little use anyway
2017-09-30 11:18:22 +02:00
Aleksey Kladov d11a429ded Add CONTRIBUTING.md 2017-09-03 12:47:49 +03:00
Alex Crichton 50a46f4708 Remove lots of dated configuration from this repo
Lots of data build stuff is still here from awhile ago when this repo was
producing Cargo binaries, but the rust-lang/rust repo is now responsible for all
these binaries and build configurations. We no longer need to produce artifacts
or have tons of cross-compiles as rust-lang/rust does all that work, instead
let's just test the likely-to-regress platforms and have rust-lang/rust take
care of the rest.

This commit:

* Deletes the old `configure` script and `Makefile`
* Rewrites `src/doc` management as a shell script
* Trims down Travis/AppVeyor configuration
2017-05-31 14:23:01 -07:00
amotz ffff3415ca Fix AppVeyor badge URL 2017-03-01 21:55:57 +09:00
Alex Crichton cd3c2519f4 Delete manual installation URLs
These have existed since the beginning of time, but they haven't needed to exist
since long before 1.0. Let's just delete them now that they're out of date
anyway.
2016-12-29 08:06:38 -08:00
Alex Crichton ea182b8371 Update README build instructions 2016-12-25 17:02:04 -08:00
Carol (Nichols || Goulding) c41a680e73 Add information about Cargo releases going with Rust releases 2016-09-30 19:53:02 -04:00
Carol (Nichols || Goulding) 5c793a2947 Document recommended way for running tests
Fixes #3084.
2016-09-12 21:45:29 -04:00
Carol (Nichols || Goulding) 9e0da6fb20 Add instructions for rendering docs locally to the README 2016-05-13 16:47:11 -04:00
Stephen Becker IV 41ecf3b2c3 Add flair to readme
Add the travis-ci and appveyor build badges to the readme
2016-03-12 12:23:13 -08:00
Stephen Becker IV 2cdaa41929 Fix name
And move line below code block per merge request.
2016-02-24 22:45:08 -08:00
Stephen Becker IV 81d1be4923 Add a note for the 32 bit flag
Per https://github.com/rust-lang/cargo/issues/1375

Just add a note around the python script flag
2016-02-24 21:27:27 -08:00
Carol (Nichols || Goulding) 49a84aae21 Add a note about release notes being in Rust's release notes 2016-02-11 20:04:04 -05:00
Alex Crichton d261ffda59 Add more info to README about compiling
Running `cargo build` should work just fine to build cargo as well as not
running the python script to download rustc itself. Now that Cargo runs on
stable (and a pretty old stable) most Rust installations should "Just Work" to
build Cargo.
2016-01-22 16:09:17 -08:00
Abhishek Chanda 8af3091ed6 Do not generate .pyc file
The -B switch turns off .pyc file generation
2015-08-17 00:18:34 -07:00
Michal Vyskocil 17c1f87093 remove the name of submodule per recomendation of @alexcrichton 2015-07-29 00:01:11 +02:00
Michal Vyskocil 0cc228c017 Problem: make install fail on non-existing rust-installer
Solution: add a note about calling git submodule to README.md
2015-07-28 23:38:22 +02:00
Alex Crichton cfb69ad256 Rewrite dependency installation in Python
This commit aims to have the end goal of adding AppVeyor CI support to this
repo, and along the way it ended up meaning that the dependency installation
bits were rewritten in Python. This has a number of benefits:

* Python is more portable than shell
* Python is more readable than shell
* curl is no longer required on Windows (powershell is used for downloads)

There are also a few minor updates made as part of this commit as well:

* The README has been updated in how to build Cargo
* We now use `sudo: false` on Travis for faster builds. This is done by
  specifying packages to install instead of installing them ourselves.
* pkg-config is no longer listed as a required program
2015-07-07 15:16:09 -07:00
Jakub 1e5f70635a Add Third-party cargo subcommands to the README 2015-02-23 14:17:50 +01:00
Kevin Ballard 6d873561e8 Use "$PWD" instead of pwd in install instructions
There's no need to promote the use of the `pwd` command when shells
export the current directory as `$PWD`. Using `$PWD` makes the
commandline work in fish as well. Additionally, quote the variable so it
works properly even if the cwd has a space in it.
2014-12-29 13:05:22 -08:00
Alex Crichton 345ca2139f Fix readme instructions for submodules 2014-12-21 09:37:32 -08:00
Brian Anderson 8498392346 Use rust-installer for installation
This is just a refactoring to put Cargo and Rust on the same installer script.
2014-12-11 12:18:29 -08:00
Steve Klabnik 78f20cabfc One does not simply make Cargo
README fix with correct build instructions for building from source.
2014-11-18 09:55:01 -05:00
Pierre Krieger 18591de2e8 Update links to windows nightlies in the README 2014-11-10 13:44:28 +01:00
Steve Klabnik 1464853e83 Fix requirements in README 2014-10-30 23:34:11 -04:00
Eduardo Bautista bd536dccda Update docs url 2014-10-18 01:17:02 -05:00
Alex Crichton 74705a052d Install materials to comply with upstream licenses
This follows #656 by mentioning OpenSSL in the README, as well as install all
license files on installation. A hand-generated LICENSE-THIRD-PARTY is also
included.

Closes #656

This also approaches #657 by mentioning that we have GPL software in the README.
Cargo will hopefully support a more complete "all source" distribution in the
future, but at this time there is not an easy way to generate a complete source
tarball via cargo.
2014-10-02 12:43:05 -07:00
Brian Anderson cce8d582d6 Change downloads to HTTPS 2014-09-18 19:16:19 -07:00
Brian Anderson 009d3959ab Update windows downloads 2014-09-18 16:57:29 -07:00
Eduardo Bautista 2f86d7420c Update "Contributing to the Docs" 2014-09-11 16:12:26 -05:00
Alex Crichton 5ef037584b Add a note about required build tools and packages
Closes #518
2014-09-07 11:25:26 -07:00
Colin Dean a39a331a38 Remove $ from lines in readme to improve copyability
When a $ is present, it prevents someone from easily copying and
pasting the whole block.
2014-08-17 19:02:04 -04:00
Alex Crichton 3b77b2c763 Fix all tests and rebase conflicts
This rebases the lockfile branch to master and updates all code necessary to get
the tests passing again.
2014-07-31 10:16:03 -07:00
Alex Crichton c1bbc721a3 Update the README with current information
Closes #271
Closes #274
Closes #292
2014-07-30 10:11:36 -07:00
Benjamin R. Haskell e2353a5b63 Update README with new build instructions
- Remove outdated `git submodule` instructions
- Add new `./configure` build step
2014-07-29 01:14:36 -04:00
Alex Crichton 1aaaf85166 Add an installation script to the repo
This updates the `make install` target and adds a new `make dist` target which
will prepare a distributable tarball with an install script. All work is based
off the equivalent rust nightly tarball and nightly installation scripts.

Closes #159
Closes #184
2014-07-14 08:18:49 -07:00
Tomaka17 f11ee1f4f0 Make README nightlies links clickable 2014-07-10 08:38:25 -07:00
Alex Crichton ffd985f1f4 Add documentation about cargo nightlies 2014-07-07 07:49:14 -07:00
Brian Cobb 7fdde8e1eb README uses "its" instead of "it's" 2014-07-02 08:54:46 -05:00
Yehuda Katz fe6240146d Update README.md 2014-06-24 13:37:28 -07:00
Alex Crichton c6fc2f587d Add the standard Rust Apache/MIT license
This copies the same Apache and MIT license files from the rust-lang/rust
repository to the cargo repository. It notable retains the same copyright line
as the rust repository:

    Copyright (c) 2014 The Rust Project Developers

The COPYRIGHT file from the rust repository was not copied over as it looked
like it mainly contained information about third party dependencies, which cargo
does not have yet.

The wording at the end of the rust repository's README.md was also copied over
to cargo's README.md with tweaks to not mention COPYRIGHT and third-party BSD
licenses.

Closes #34
2014-06-24 12:26:13 -07:00
Alex Crichton eb7a16376f Clarify make install exists as a target
Closes #39
2014-06-24 06:44:47 -07:00
Yehuda Katz bbd57905ca Update README.md 2014-06-23 23:09:03 -07:00