diff --git a/README.md b/README.md index 3d86567d7..547fd7600 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,14 @@ Rally is developed for Unix and is actively tested on Linux and macOS. Rally sup ### Installing Rally -**Note**: If you actively develop on Elasticsearch, we recommend that you `install Rally in development mode `_ instead as Elasticsearch is fast moving and Rally always adapts accordingly to the latest main version. +**Note**: If you actively develop on Elasticsearch, we recommend that you [install Rally in development mode](https://esrally.readthedocs.io/en/latest/developing.html#installation-instructions-for-development) instead as Elasticsearch is fast moving and Rally always adapts accordingly to the latest main version. -Install Python 3.8+ including `pip3`, git 1.9+ and an [appropriate JDK to run Elasticsearch](https://www.elastic.co/support/matrix#matrix_jvm>). Be sure that `JAVA_HOME` points to that JDK. Then run the following command, optionally prefixed by `sudo` if necessary: +Install Python 3.8+ including `pip3`, git 1.9+ and an [appropriate JDK to run Elasticsearch](https://www.elastic.co/support/matrix#matrix_jvm). Be sure that `JAVA_HOME` points to that JDK. Then run the following command, optionally prefixed by `sudo` if necessary: pip3 install esrally -If you have any trouble or need more detailed instructions, please look in the [detailed installation guide](https://esrally.readthedocs.io/en/latest/install.html>). +If you have any trouble or need more detailed instructions, please look in the [detailed installation guide](https://esrally.readthedocs.io/en/latest/install.html). ## Run your first race @@ -37,7 +37,7 @@ Now we're ready to run our first race: esrally race --distribution-version=6.0.0 --track=geonames -This will download Elasticsearch 6.0.0 and run Rally's default track - the [geonames track](https://github.com/elastic/rally-tracks/tree/master/geonames>) - against it. After the race, a summary report is written to the command line: +This will download Elasticsearch 6.0.0 and run Rally's default track - the [geonames track](https://github.com/elastic/rally-tracks/tree/master/geonames) - against it. After the race, a summary report is written to the command line: ------------------------------------------------------ _______ __ _____ @@ -101,13 +101,13 @@ This will download Elasticsearch 6.0.0 and run Rally's default track - the [geon ## Getting help * Quick help: `esrally --help` -* Look in [Rally's user guide](https://esrally.readthedocs.io/>) for more information +* Look in [Rally's user guide](https://esrally.readthedocs.io/) for more information * Ask questions about Rally in the [Rally Discuss forum](https://discuss.elastic.co/tags/c/elastic-stack/elasticsearch/rally). -* File improvements or bug reports in our [Github repo](https://github.com/elastic/rally/issues>). +* File improvements or bug reports in our [Github repo](https://github.com/elastic/rally/issues). ## How to Contribute -See all details in the [contributor guidelines](https://github.com/elastic/rally/blob/master/CONTRIBUTING.md>). +See all details in the [contributor guidelines](https://github.com/elastic/rally/blob/master/CONTRIBUTING.md). ## License @@ -120,7 +120,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 +> http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT