Browse Source

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.
pull/436/head
Pedro Paulo 5 years ago committed by GitHub
parent
commit
87aea64c1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 24
      README.md

24
README.md

@ -19,15 +19,15 @@ Currently, it has support for some of the language.
<https://boa-dev.github.io/boa/> <https://boa-dev.github.io/boa/>
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 ## Development documentation
You can check the internal development docs at <https://boa-dev.github.io/boa/doc> You can check the internal development docs at <https://boa-dev.github.io/boa/doc>.
## Benchmarks ## Benchmarks
<https://boa-dev.github.io/boa/dev/bench/> See [Benchmarks](https://boa-dev.github.io/boa/dev/bench/).
## Contributing ## Contributing
@ -37,7 +37,7 @@ some configurations ready for VSCode.
### Debugging ### Debugging
See [Debugging](./docs/debugging.md). Check [debugging.md](./docs/debugging.md) for more info on debugging.
### Web Assembly ### Web Assembly
@ -49,21 +49,21 @@ $ yarn install
$ yarn serve $ yarn serve
``` ```
In the console you can use `window.evaluate` to pass JavaScript in 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` To develop on the web assembly side you can run `yarn serve` then go to `http://localhost:8080`.
## Roadmap ## Roadmap
See Milestones See [Milestones](https://github.com/boa-dev/boa/milestones).
## Changelog ## Changelog
see [CHANGELOG](./CHANGELOG.md) See [CHANGELOG.md](./CHANGELOG.md).
## Usage ## Usage
- Clone this repo - 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.
- 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!
## Command-line Options ## Command-line Options
@ -88,7 +88,7 @@ ARGS:
## Communication ## Communication
Feel free to contact us on Discord https://discord.gg/tUFFk9Y Feel free to contact us on [Discord](https://discord.gg/tUFFk9Y).
## Example ## Example
@ -96,4 +96,4 @@ Feel free to contact us on Discord https://discord.gg/tUFFk9Y
## License ## 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.

Loading…
Cancel
Save