README for esp-rs/rust

Author: MabezDev

README.md

@@ -1,4 +1,18 @@
-# The Rust Programming Language
+# The Rust Programming Language for Espressif chips
+
+This fork enables projects to be built for the Xtensa-based ESP32, ESP32-SXX and ESP8266 using [Espressif's llvm fork](https://github.com/espressif/llvm-project). (RiscV chips like ESP32-CXX are already supported in stock Rust.)
+
+Moreover, this fork enables Rust STD support (networking, threads, and filesystem) for all chips in the ESP32 family (Xtensa and RiscV), by optionally linking with the ESP-IDF framework.
+
+The [esp-rs](https://github.com/esp-rs) organization has been formed to develop runtime, pac and hal crates for the Espressif chips (bare-metal as well as ESP-IDF based).
+
+Join in on the discussion: https://matrix.to/#/#esp-rs:matrix.org!
+
+## Installation
+
+Please see the most up to date instructions in the [esp rust book](https://esp-rs.github.io/).
+
+---
 
 This is the main source code repository for [Rust]. It contains the compiler,
 standard library, and documentation.
@@ -54,7 +68,7 @@ by running it with the `--help` flag or reading the [rustc dev guide][rustcguide
    * `g++` 5.1 or later or `clang++` 3.5 or later
    * `python` 3 or 2.7
    * GNU `make` 3.81 or later
-   * `cmake` 3.13.4 or later
+   * `cmake` 3.4.3 or later
    * `ninja`
    * `curl`
    * `git`
@@ -64,8 +78,8 @@ by running it with the `--help` flag or reading the [rustc dev guide][rustcguide
 2. Clone the [source] with `git`:
 
    ```sh
-   git clone https://github.com/rust-lang/rust.git
-   cd rust
+   $ git clone https://github.com/rust-lang/rust.git
+   $ cd rust
    ```
 
 [source]: https://github.com/rust-lang/rust
@@ -77,7 +91,7 @@ by running it with the `--help` flag or reading the [rustc dev guide][rustcguide
     Copy the default `config.toml.example` to `config.toml` to get started.
 
     ```sh
-    cp config.toml.example config.toml
+    $ cp config.toml.example config.toml
     ```
 
     If you plan to use `x.py install` to create an installation, it is recommended
@@ -88,7 +102,7 @@ by running it with the `--help` flag or reading the [rustc dev guide][rustcguide
 4. Build and install:
 
     ```sh
-    ./x.py build && ./x.py install
+    $ ./x.py build && ./x.py install
     ```
 
     When complete, `./x.py install` will place several programs into
@@ -113,7 +127,7 @@ build.
 
 [MSYS2][msys2] can be used to easily build Rust on Windows:
 
-[msys2]: https://www.msys2.org/
+[msys2]: https://msys2.github.io/
 
 1. Grab the latest [MSYS2 installer][msys2] and go through the installer.
 
@@ -126,15 +140,15 @@ build.
 
    ```sh
    # Update package mirrors (may be needed if you have a fresh install of MSYS2)
-   pacman -Sy pacman-mirrors
+   $ pacman -Sy pacman-mirrors
 
    # Install build tools needed for Rust. 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' and 'ninja'
    # packages from the 'msys2' subsystem. The build has historically been known
    # to fail with these packages.
-   pacman -S git \
+   $ pacman -S git \
                make \
                diffutils \
                tar \
@@ -147,7 +161,7 @@ build.
 4. Navigate to Rust's source code (or clone it), then build it:
 
    ```sh
-   ./x.py build && ./x.py install
+   $ ./x.py build && ./x.py install
    ```
 
 #### MSVC
@@ -165,7 +179,7 @@ With these dependencies installed, you can build the compiler in a `cmd.exe`
 shell with:
 
 ```sh
-python x.py build
+> python x.py build
 ```
 
 Currently, building Rust only works with some known versions of Visual Studio. If
@@ -174,8 +188,8 @@ you may need to force rustbuild to use an older version. This can be done
 by manually calling the appropriate vcvars file before running the bootstrap.
 
 ```batch
-CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
-python x.py build
+> CALL "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
+> python x.py build
 ```
 
 #### Specifying an ABI
@@ -201,8 +215,8 @@ 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
+$ make && sudo make install
 ```
 
 When using the configure script, the generated `config.mk` file may override the
@@ -214,7 +228,7 @@ When using the configure script, the generated `config.mk` file may override the
 If you’d like to build the documentation, it’s almost the same:
 
 ```sh
-./x.py doc
+$ ./x.py doc
 ```
 
 The generated documentation will appear under `doc` in the `build` directory for
@@ -285,4 +299,4 @@ Third-party logos may be subject to third-party copyrights and trademarks. See
 
 [rust-foundation]: https://foundation.rust-lang.org/
 [media-guide]: https://www.rust-lang.org/policies/media-guide
-[policies-licenses]: https://www.rust-lang.org/policies/licenses
+[policies-licenses]: https://www.rust-lang.org/policies/licenses