Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
trvswgnr committed Jun 23, 2023
1 parent e181e93 commit 550ccf0
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# Cargo
# Crabgo

Cargo downloads your Rust project’s dependencies and compiles your project.
Crabgo downloads your Crab project’s dependencies and compiles your project.

**To start using Cargo**, learn more at [The Cargo Book].
**To start using Crabgo**, learn more at [The Crabgo Book].

**To start developing Cargo itself**, read the [Cargo Contributor Guide].
**To start developing Crabgo itself**, read the [Crabgo Contributor Guide].

[The Cargo Book]: https://doc.rust-lang.org/cargo/
[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/
[The Crabgo Book]: https://doc.rust-lang.org/cargo/
[Crabgo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/

## Code Status

[![CI](https://github.com/rust-lang/cargo/actions/workflows/main.yml/badge.svg?branch=auto-cargo)](https://github.com/rust-lang/cargo/actions/workflows/main.yml)
<!--
[![CI](https://github.com/rust-lang/cargo/actions/workflows/main.yml/badge.svg?branch=auto-cargo)](https://github.com/rust-lang/cargo/actions/workflows/main.yml) -->

Code documentation: https://docs.rs/cargo/

## Installing Cargo
## Installing Crabgo

Cargo is distributed by default with Rust, so if you've got `rustc` installed
locally you probably also have `cargo` installed locally.
Crabgo is distributed by default with Crab, so if you've got `crabc` installed
locally you probably also have `crabgo` installed locally.

## Compiling from Source

### Requirements

Cargo requires the following tools and packages to build:
Crabgo requires the following tools and packages to build:

* `cargo` and `rustc`
* `crabgo` and `crabc`
* A C compiler [for your platform](https://github.com/rust-lang/cc-rs#compile-time-requirements)
* `git` (to clone this repository)

Expand All @@ -35,11 +35,11 @@ Cargo requires the following tools and packages to build:
The following are optional based on your platform and needs.

* `pkg-config` — This is used to help locate system packages, such as `libssl` headers/libraries. This may not be required in all cases, such as using vendored OpenSSL, or on Windows.
* OpenSSL — Only needed on Unix-like systems and only if the `vendored-openssl` Cargo feature is not used.
* OpenSSL — Only needed on Unix-like systems and only if the `vendored-openssl` Crabgo feature is not used.

This requires the development headers, which can be obtained from the `libssl-dev` package on Ubuntu or `openssl-devel` with apk or yum or the `openssl` package from Homebrew on macOS.

If using the `vendored-openssl` Cargo feature, then a static copy of OpenSSL will be built from source instead of using the system OpenSSL.
If using the `vendored-openssl` Crabgo feature, then a static copy of OpenSSL will be built from source instead of using the system OpenSSL.
This may require additional tools such as `perl` and `make`.

On macOS, common installation directories from Homebrew, MacPorts, or pkgsrc will be checked. Otherwise it will fall back to `pkg-config`.
Expand All @@ -57,39 +57,39 @@ The build will automatically use vendored versions of the following libraries. H
* [`libssh2`](https://www.libssh2.org/) — Used for SSH access to git repositories.
* [`libz`](https://zlib.net/) (aka zlib) — Used for data compression.

It is recommended to use the vendored versions as they are the versions that are tested to work with Cargo.
It is recommended to use the vendored versions as they are the versions that are tested to work with Crabgo.

### Compiling

First, you'll want to check out this repository

```
git clone https://github.com/rust-lang/cargo.git
cd cargo
git clone https://github.com/crablang/crabgo.git
cd crabgo
```

With `cargo` already installed, you can simply run:
With `crabgo` already installed, you can simply run:

```
cargo build --release
crabgo build --release
```

## Adding new subcommands to Cargo
## Adding new subcommands to Crabgo

Cargo is designed to be extensible with new subcommands without having to modify
Cargo itself. See [the Wiki page][third-party-subcommands] for more details and
Crabgo is designed to be extensible with new subcommands without having to modify
Crabgo itself. See [the Wiki page][third-party-subcommands] for more details and
a list of known community-developed subcommands.

[third-party-subcommands]: https://github.com/rust-lang/cargo/wiki/Third-party-cargo-subcommands


## Releases

Cargo releases coincide with Rust releases.
High level release notes are available as part of [Rust's release notes][rel].
Crabgo releases coincide with Crab releases.
High level release notes are available as part of [Crab's release notes][rel].
Detailed release notes are available in this repo at [CHANGELOG.md].

[rel]: https://github.com/rust-lang/rust/blob/master/RELEASES.md
[rel]: https://github.com/crablang/crabgo/blob/master/RELEASES.md
[CHANGELOG.md]: CHANGELOG.md

## Reporting issues
Expand All @@ -98,16 +98,16 @@ Found a bug? We'd love to know about it!

Please report all issues on the GitHub [issue tracker][issues].

[issues]: https://github.com/rust-lang/cargo/issues
[issues]: https://github.com/crablang/crabgo/issues

## Contributing

See the **[Cargo Contributor Guide]** for a complete introduction
to contributing to Cargo.
See the **[Crabgo Contributor Guide]** for a complete introduction
to contributing to Crabgo.

## License

Cargo is primarily distributed under the terms of both the MIT license
Crabgo is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0).

See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
Expand Down

0 comments on commit 550ccf0

Please sign in to comment.