aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVlad Doster <mvdoster@gmail.com>2021-01-10 22:34:23 -0600
committerPhilip Herron <herron.philip@googlemail.com>2021-01-12 13:33:12 +0000
commitda3e15f13f8e3f00f1826efec8a74ebb67637b4c (patch)
treeef7c57c706c2e784ddfcc79d4608e06ec059c6c8
parent5a9ceba8fd21973118f1866686aca5622cc60ba2 (diff)
downloadgcc-da3e15f13f8e3f00f1826efec8a74ebb67637b4c.zip
gcc-da3e15f13f8e3f00f1826efec8a74ebb67637b4c.tar.gz
gcc-da3e15f13f8e3f00f1826efec8a74ebb67637b4c.tar.bz2
(docs) update README.md
- Correct grammar/spelling - Add language syntax for code fences - Link to test-suite file
-rw-r--r--README.md38
1 files changed, 19 insertions, 19 deletions
diff --git a/README.md b/README.md
index 1e1ec49..4129370 100644
--- a/README.md
+++ b/README.md
@@ -5,18 +5,18 @@
# GCC Rust
![GCC Rust](logo.png?raw=true "GCC rust Logo")
-This is a full alternative implementaion of the Rust language ontop of GCC which the goal
+gccrs is a full alternative implementation of the Rust language ontop of GCC with the goal
to become fully upstream with the GNU toolchain.
The origin of this project was a community effort several years ago where Rust was still at version 0.9;
the language was subject to so much change that it became difficult for a community effort to play catch up.
-Now that the language is in a stable state, it is a good time to create alternative compilers. The developers of
+Now that the language is stable, it is an excellent time to create alternative compilers. The developers of
the project are keen “Rustaceans” with a desire to give back to the Rust community and to learn what GCC is capable
of when it comes to a modern language.
-## Development Enviroment
+## Development Environment
-Fetch dependancies for ubuntu:
+Fetch dependencies for Ubuntu:
```bash
$ apt install build-essential libgmp3-dev libmpfr-dev libmpc-dev flex bison autogen gcc-multilib dejagnu
@@ -28,8 +28,8 @@ Clone the repository
$ git clone git@github.com:Rust-GCC/gccrs.git
```
-Compilation script. It is important to remember that GNU toolchain projects are designed to be built outside of its source directory
-this is why a build directory is created.
+Compilation script. It is important to remember that GNU toolchain projects are designed to be built outside of their source directory
+which is why a build directory is created.
```bash
$ mkdir gccrs-build
@@ -40,33 +40,33 @@ $ make
Running the compiler itself without make install we can simply invoke the compiler proper:
-```
+```bash
$ gdb --args ./gcc/rust1 test.rs -frust-dump-parse -Warray-bounds -dumpbase test.rs -mtune=generic -march=x86-64 -O0 -version -fdump-tree-gimple -o test.s -L/lib/x86_64-linux-gnu -L/lib/../lib64 -L/usr/lib/x86_64-linux-gnu -L/usr/lib/../lib64
```
To invoking the compiler driver (gccrs) we need to:
-```
+```bash
$ make install
```
Then invoke the compiler as expected:
-```
+```bash
$ gccrs -g -O2 -c test.rs -o test.o
$ gccrs -o test test.o
```
## Testsuite
-The test suite can be invoked via:
+Invoke the test suite via:
-```
+```bash
$ make check-rust
```
-Test cases can be found within gcc/testsuite/rust.test please feel free to contribute your specific
-test cases referencing any issues on github.
+Test cases are located within [gcc/testsuite/rust.test](gcc/testsuite/rust.test) please feel free to contribute your specific
+test cases referencing any issues on Github.
## Docker image
@@ -74,13 +74,13 @@ There is a docker image hosted over on:
https://hub.docker.com/repository/docker/philberty/gccrs
-```
+```bash
$ docker pull philberty/gccrs
```
Or you can build your own image:
-```
+```bash
$ docker build . -t gccrs-dev
$ docker run --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp \
gccrs-dev:latest gccrs -g -O2 -c \
@@ -89,14 +89,14 @@ $ docker run --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp \
## Contributing
-Please be aware this project is designed to be pushed upstream to GCC when we reach some milestones and this means we require
-contribtions to have copyright assignment in place. Please see: https://gcc.gnu.org/contribute.html
+Please be aware this project is designed to be pushed upstream to GCC when we reach some milestones, and this means we require
+contributions to have copyright assignment in place. Please see https://gcc.gnu.org/contribute.html.
-Not all contributions must be code, we would love to see new test cases or bugs and issues to be reported. Feel free to add any comments on open PRs
+Not all contributions must be code; we would love to see new test cases or bugs and issues to be reported. Feel free to add any comments on open PRs
## Community
-We can be found on all usual Rust channels such as Zulip but we also have our own channels:
+We can be found on all usual Rust channels such as Zulip, but we also have our own channels:
* GCC Rust Zulip: https://gcc-rust.zulipchat.com/
* Twitter: https://twitter.com/gcc_rust