docs: update README by structuring the topics (#1958)

It changes the following:

- Updates (structuring) the readme to make it easier for first-time users to read the repository.

CONTRIBUTING.md

@@ -24,7 +24,7 @@ tool to use. It will install Rust and allow you to switch between _nightly_,
 _stable_ and _beta_. You can also install additional components. In Linux, you
 can run:
 
-```
+```shell
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
 
@@ -75,13 +75,13 @@ Boa provides its own test suite, and can also run the official ECMAScript test s
 suite, you can just run the normal `cargo test`, and to run the full ECMAScript test suite, you can run it
 with this command:
 
-```
+```shell
 cargo run --release --bin boa_tester -- run -v 2> error.log
 ```
 
 Note that this requires the `test262` submodule to be checked out, so you will need to run the following first:
 
-```
+```shell
 git submodule init && git submodule update
 ```
 
@@ -100,7 +100,7 @@ type tests, use `-s test/language/types/number`.
 Finally, if you're using the verbose flag and running a sub suite with a small number of tests, then the output will
 be more readable if you disable parallelism with the `-d` flag. All together it might look something like:
 
-```
+```shell
 cargo run --release --bin boa_tester -- run -vv -d -s test/language/types/number 2> error.log
 ```
 

README.md

@@ -2,7 +2,7 @@
 
 <p align="center">
     <img
-      alt="logo"
+      alt="Boa Logo"
       src="./assets/logo.svg"
       width="30%"
     />
@@ -32,11 +32,7 @@ You can check the internal development docs at <https://boa-dev.github.io/boa/do
 
 ## Conformance
 
-To know how much of the ECMAScript specification does Boa cover, you can check out results running the ECMASCript Test262 test suite [here](https://boa-dev.github.io/boa/test262/).
+To know how much of the _ECMAScript_ specification does Boa cover, you can check out results running the _ECMASCript Test262_ test suite [here](https://boa-dev.github.io/boa/test262/).
-
-## Benchmarks
-
-See [Benchmarks](https://boa-dev.github.io/boa/dev/bench/).
 
 ## Contributing
 
@@ -50,10 +46,10 @@ Check [debugging.md](./docs/debugging.md) for more info on debugging.
 
 ### Web Assembly
 
-This interpreter can be exposed to javascript!
+This interpreter can be exposed to JavaScript!
 You can build the example locally with:
 
-```
+```shell
 $ yarn install
 $ yarn serve
 ```
@@ -61,27 +57,19 @@ $ yarn serve
 In the console you can use `window.evaluate` to pass JavaScript in.
 To develop on the web assembly side you can run `yarn serve` then go to `http://localhost:8080`.
 
-## Roadmap
-
-See [Milestones](https://github.com/boa-dev/boa/milestones).
-
-## Changelog
-
-See [CHANGELOG.md](./CHANGELOG.md).
-
 ## Usage
 
 - Clone this repo.
-- Run with `cargo run -- test.js` where `test.js` is an existing JS file.
+- Run with `cargo run -- test.js` where `test.js` is an existing JS file with any JS valid code.
-- If any JS doesn't work then it's a bug. Please raise an issue!
+- If any JS doesn't work then it's a bug. Please raise an [issue](https://github.com/boa-dev/boa/issues/)!
 
-## Profiling
+### Example
 
-See [Profiling](./docs/profiling.md)
+![Example](docs/img/latestDemo.gif)
 
 ## Command-line Options
 
-```
+```shell
 USAGE:
     boa [OPTIONS] [FILE]...
 
@@ -97,13 +85,25 @@ ARGS:
     <FILE>...    The JavaScript file(s) to be evaluated
 ```
 
-## Communication
+## Roadmap
 
-Feel free to contact us on [Discord](https://discord.gg/tUFFk9Y).
+See [Milestones](https://github.com/boa-dev/boa/milestones).
 
-## Example
+## Benchmarks
 
-![Example](docs/img/latestDemo.gif)
+See [Benchmarks](https://boa-dev.github.io/boa/dev/bench/).
+
+## Profiling
+
+See [Profiling](./docs/profiling.md).
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).
+
+## Communication
+
+Feel free to contact us on [Discord](https://discord.gg/tUFFk9Y).
 
 ## License