From 87aea64c1f6965b4994d780da5f3e4e7fa4c02d0 Mon Sep 17 00:00:00 2001 From: Pedro Paulo <32345702+pedropaulosuzuki@users.noreply.github.com> Date: Sat, 30 May 2020 09:32:02 -0300 Subject: [PATCH] Consistency at README.md (#424) Tries to make the README.md file more consistent. In some places the lines ended with a ".", while in others it did not. The licenses at the ended were missing some links and some sessions, such as [Benchmark] did not have any text besides the main link, among other things. --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a186397834..86b5db4149 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,15 @@ Currently, it has support for some of the language. -You can get more verbose errors when running from the command line +You can get more verbose errors when running from the command line. ## Development documentation -You can check the internal development docs at +You can check the internal development docs at . ## Benchmarks - +See [Benchmarks](https://boa-dev.github.io/boa/dev/bench/). ## Contributing @@ -37,7 +37,7 @@ some configurations ready for VSCode. ### Debugging -See [Debugging](./docs/debugging.md). +Check [debugging.md](./docs/debugging.md) for more info on debugging. ### Web Assembly @@ -49,21 +49,21 @@ $ yarn install $ 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` +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 +See [Milestones](https://github.com/boa-dev/boa/milestones). ## Changelog -see [CHANGELOG](./CHANGELOG.md) +See [CHANGELOG.md](./CHANGELOG.md). ## Usage -- Clone this repo -- Run with `cargo run -- test.js` where `test.js` is an existing JS file +- Clone this repo. +- Run with `cargo run -- test.js` where `test.js` is an existing JS file. - If any JS doesn't work then it's a bug. Please raise an issue! ## Command-line Options @@ -88,7 +88,7 @@ ARGS: ## Communication -Feel free to contact us on Discord https://discord.gg/tUFFk9Y +Feel free to contact us on [Discord](https://discord.gg/tUFFk9Y). ## Example @@ -96,4 +96,4 @@ Feel free to contact us on Discord https://discord.gg/tUFFk9Y ## License -This project is licensed under the Unlicense or MIT licenses, at your option. +This project is licensed under the [Unlicense](./LICENSE-UNLICENSE) or [MIT](./LICENSE-MIT) licenses, at your option.