use crablang readme

Author: Travis Wagner

README.md

@@ -1,30 +1,38 @@
-# The Rust Programming Language
+<img src="https://user-images.githubusercontent.com/8974888/231858967-7c37bf1e-335b-4f5a-9760-da97be9f54bb.png" width="200" />
 
-[![Rust Community](https://img.shields.io/badge/Rust_Community%20-Join_us-brightgreen?style=plastic&logo=rust)](https://www.rust-lang.org/community)
+# The Crab Programming Language
 
-This is the main source code repository for [Rust]. It contains the compiler,
+[![CrabLang Community](https://img.shields.io/badge/CrabLang_Community%20-Join_us-brightgreen?style=plastic&logo=discord)](https://community.crablang.org)
+
+This is the main source code repository for [Crab](https://github.com/crablang/crab). It contains the compiler,
 standard library, and documentation.
 
-[Rust]: https://www.rust-lang.org/
+[CrabLang]: https://www.crablang.org/
 
 **Note: this README is for _users_ rather than _contributors_.**
 If you wish to _contribute_ to the compiler, you should read
 [CONTRIBUTING.md](CONTRIBUTING.md) instead.
 
 ## Quick Start
 
+To get started with the renamed CrabLang toolchain, run the following:
+
+```sh
+sh <(curl https://install.crablang.org -L)
+```
+
+\* currently Unix only
+
+<!-- 
 Read ["Installation"] from [The Book].
 
-["Installation"]: https://doc.rust-lang.org/book/ch01-01-installation.html
-[The Book]: https://doc.rust-lang.org/book/index.html
+["Installation"]: https://doc.crablang.org/book/ch01-01-installation.html
+[The Book]: https://doc.crablang.org/book/index.html -->
 
 ## Installing from Source
 
-The Rust build system uses a Python script called `x.py` to build the compiler,
+The Crab build system uses a Python script called `x.py` to build the compiler,
 which manages the bootstrapping process. It lives at the root of the project.
-It also uses a file named `config.toml` to determine various configuration
-settings for the build. You can see a full list of options in
-`config.example.toml`.
 
 The `x.py` command can be run directly on most Unix systems in the following
 format:
@@ -34,14 +42,25 @@ format:
 ```
 
 This is how the documentation and examples assume you are running `x.py`.
-See the [rustc dev guide][rustcguidebuild] if this does not work on your
-platform.
+
+Some alternative ways are:
+
+```sh
+# On a Unix shell if you don't have the necessary `python3` command
+./x <subcommand> [flags]
+
+# On the Windows Command Prompt (if .py files are configured to run Python)
+x.py <subcommand> [flags]
+
+# You can also run Python yourself, e.g.:
+python x.py <subcommand> [flags]
+```
 
 More information about `x.py` can be found by running it with the `--help` flag
-or reading the [rustc dev guide][rustcguidebuild].
+or reading the [crabc dev guide][crabcguidebuild].
 
-[gettingstarted]: https://rustc-dev-guide.rust-lang.org/getting-started.html
-[rustcguidebuild]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html#what-is-xpy
+[gettingstarted]: https://crabc-dev-guide.crablang.org/getting-started.html
+[crabcguidebuild]: https://crabc-dev-guide.crablang.org/building/how-to-build-and-run.html
 
 ### Dependencies
 
@@ -55,7 +74,7 @@ Make sure you have installed the dependencies:
 * `pkg-config` if you are compiling on Linux and targeting Linux
 * `libiconv` (already included with glibc on Debian-based distros)
 
-To build Cargo, you'll also need OpenSSL (`libssl-dev` or `openssl-devel` on
+To build Crabgo, you'll also need OpenSSL (`libssl-dev` or `openssl-devel` on
 most Unix distros).
 
 If building LLVM from source, you'll need additional tools:
@@ -71,33 +90,36 @@ If building LLVM from source, you'll need additional tools:
 On tier 1 or tier 2 with host tools platforms, you can also choose to download
 LLVM by setting `llvm.download-ci-llvm = true`.
 Otherwise, you'll need LLVM installed and `llvm-config` in your path.
-See [the rustc-dev-guide for more info][sysllvm].
+See [the crabc-dev-guide for more info][sysllvm].
 
-[sysllvm]: https://rustc-dev-guide.rust-lang.org/building/new-target.html#using-pre-built-llvm
+[sysllvm]: https://crabc-dev-guide.crablang.org/building/new-target.html#using-pre-built-llvm
 
 
 ### Building on a Unix-like system
 
-#### Build steps
-
 1. Clone the [source] with `git`:
 
    ```sh
-   git clone https://github.com/rust-lang/rust.git
-   cd rust
+   git clone https://github.com/crablang/crab.git
+   cd crab
    ```
 
-[source]: https://github.com/rust-lang/rust
+[source]: https://github.com/crablang/crablang
 
 2. Configure the build settings:
 
+   The CrabLang build system uses a file named `config.toml` in the root of the
+   source tree to determine various configuration settings for the build.
+   Set up the defaults intended for distros to get started. You can see a full
+   list of options in `config.example.toml`.
+
    ```sh
-   ./configure
+   printf 'profile = "user" \nchangelog-seen = 2 \n' > config.toml
    ```
 
    If you plan to use `x.py install` to create an installation, it is
    recommended that you set the `prefix` value in the `[install]` section to a
-   directory: `./configure --set install.prefix=<path>`
+   directory.
 
 3. Build and install:
 
@@ -106,27 +128,12 @@ See [the rustc-dev-guide for more info][sysllvm].
    ```
 
    When complete, `./x.py install` will place several programs into
-   `$PREFIX/bin`: `rustc`, the Rust compiler, and `rustdoc`, the
-   API-documentation tool. By default, it will also include [Cargo], Rust's
-   package manager. You can disable this behavior by passing
-   `--set build.extended=false` to `./configure`.
-
-[Cargo]: https://github.com/rust-lang/cargo
-
-#### Configure and Make
-
-This project provides a configure script and makefile (the latter of which just
-invokes `x.py`). `./configure` is the recommended way to programatically
-generate a `config.toml`. `make` is not recommended (we suggest using `x.py`
-directly), but it is supported and we try not to break it unnecessarily.
-
-```sh
-./configure
-make && sudo make install
-```
+   `$PREFIX/bin`: `crabc`, the CrabLang compiler, and `crablangdoc`, the
+   API-documentation tool. If you've set `profile = "user"` or
+   `build.extended = true`, it will also include [Crabgo], CrabLang's package
+   manager.
 
-`configure` generates a `config.toml` which can also be used with normal `x.py`
-invocations.
+[Crabgo]: https://github.com/crablang/crabgo
 
 ### Building on Windows
 
@@ -147,23 +154,23 @@ from the Java documentation.
 [winget]: https://github.com/microsoft/winget-cli
 
 There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by
-Visual Studio and the GNU ABI used by the GCC toolchain. Which version of Rust
+Visual Studio and the GNU ABI used by the GCC toolchain. Which version of CrabLang
 you need depends largely on what C/C++ libraries you want to interoperate with.
-Use the MSVC build of Rust to interop with software produced by Visual Studio
+Use the MSVC build of CrabLang to interop with software produced by Visual Studio
 and the GNU build to interop with GNU software built using the MinGW/MSYS2
 toolchain.
 
 #### MinGW
 
-[MSYS2][msys2] can be used to easily build Rust on Windows:
+[MSYS2][msys2] can be used to easily build CrabLang on Windows:
 
 [msys2]: https://www.msys2.org/
 
 1. Download the latest [MSYS2 installer][msys2] and go through the installer.
 
 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from the MSYS2 installation
    directory (e.g. `C:\msys64`), depending on whether you want 32-bit or 64-bit
-   Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
+   CrabLang. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd
    -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead.)
 
 3. From this terminal, install the required tools:
@@ -172,7 +179,7 @@ toolchain.
    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
    pacman -Sy pacman-mirrors
 
-   # Install build tools needed for Rust. If you're building a 32-bit compiler,
+   # Install build tools needed for CrabLang. If you're building a 32-bit compiler,
    # then replace "x86_64" below with "i686". If you've already got Git, Python,
    # or CMake installed and in PATH you can remove them from this list.
    # Note that it is important that you do **not** use the 'python2', 'cmake',
@@ -188,16 +195,16 @@ toolchain.
                mingw-w64-x86_64-ninja
    ```
 
-4. Navigate to Rust's source code (or clone it), then build it:
+4. Navigate to CrabLang's source code (or clone it), then build it:
 
    ```sh
-   python x.py setup user && python x.py build && python x.py install
+   ./x.py build && ./x.py install
    ```
 
 #### MSVC
 
-MSVC builds of Rust additionally require an installation of Visual Studio 2017
-(or later) so `rustc` can use its linker. The simplest way is to get
+MSVC builds of CrabLang additionally require an installation of Visual Studio 2017
+(or later) so `crabc` can use its linker.  The simplest way is to get
 [Visual Studio], check the "C++ build tools" and "Windows 10 SDK" workload.
 
 [Visual Studio]: https://visualstudio.microsoft.com/downloads/
@@ -209,13 +216,12 @@ With these dependencies installed, you can build the compiler in a `cmd.exe`
 shell with:
 
 ```sh
-python x.py setup user
 python x.py build
 ```
 
-Right now, building Rust only works with some known versions of Visual Studio.
+Right now, building CrabLang only works with some known versions of Visual Studio.
 If you have a more recent version installed and the build system doesn't
-understand, you may need to force rustbuild to use an older version.
+understand, you may need to force crablangbuild to use an older version.
 This can be done by manually calling the appropriate vcvars file before running
 the bootstrap.
 
@@ -238,8 +244,21 @@ Windows build triples are:
 
 The build triple can be specified by either specifying `--build=<triple>` when
 invoking `x.py` commands, or by creating a `config.toml` file (as described in
-[Building on a Unix-like system](#building-on-a-unix-like-system)), and passing
-`--set build.build=<triple>` to `./configure`.
+[Installing from Source](#installing-from-source)), and modifying the `build`
+option under the `[build]` section.
+
+### Configure and Make
+
+While it's not the recommended build system, this project also provides a
+configure script and makefile (the latter of which just invokes `x.py`).
+
+```sh
+./configure
+make && sudo make install
+```
+
+`configure` generates a `config.toml` which can also be used with normal `x.py`
+invocations.
 
 ## Building Documentation
 
@@ -255,12 +274,12 @@ will be `build\x86_64-pc-windows-msvc\doc`.
 
 ## Notes
 
-Since the Rust compiler is written in Rust, it must be built by a precompiled
+Since the CrabLang compiler is written in CrabLang, it must be built by a precompiled
 "snapshot" version of itself (made in an earlier stage of development).
 As such, source builds require an Internet connection to fetch snapshots, and an
 OS that can execute the available snapshot binaries.
 
-See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a list of
+See https://doc.crablang.org/nightly/crabc/platform-support.html for a list of
 supported platforms.
 Only "host tools" platforms have a pre-compiled snapshot binary available; to
 compile for a platform without host tools you must cross-compile.
@@ -270,15 +289,15 @@ build environments that are most likely to work.
 
 ## Getting Help
 
-See https://www.rust-lang.org/community for a list of chat platforms and forums.
+Need help? Join us on discord at https://community.crablang.org! 
 
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 
-Rust is primarily distributed under the terms of both the MIT license and the
+CrabLang is primarily distributed under the terms of both the MIT license and the
 Apache License (Version 2.0), with portions covered by various BSD-like
 licenses.
 
@@ -287,15 +306,11 @@ See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and
 
 ## Trademark
 
-[The Rust Foundation][rust-foundation] owns and protects the Rust and Cargo
-trademarks and logos (the "Rust Trademarks").
-
-If you want to use these names or brands, please read the
-[media guide][media-guide].
+If you want to use any names or brands associated with Crab or CrabLang, please feel free to do so in any capacity.
 
 Third-party logos may be subject to third-party copyrights and trademarks. See
 [Licenses][policies-licenses] for details.
 
-[rust-foundation]: https://foundation.rust-lang.org/
-[media-guide]: https://foundation.rust-lang.org/policies/logo-policy-and-media-guide/
-[policies-licenses]: https://www.rust-lang.org/policies/licenses
+[crablang-foundation]: https://foundation.crablang.org/
+[media-guide]: https://foundation.crablang.org/policies/logo-policy-and-media-guide/
+[policies-licenses]: https://www.crablang.org/policies/licenses