Skip to content

Commit 35091c9

Browse files
authored
Merge pull request #191 from nlesc-recruit/update-docs-urls
Replace links to md files with links to read the docs
2 parents 57838eb + 273ecf9 commit 35091c9

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,13 @@ The default configuration of PowerSensor3 is an STM32F411 Black Pill microcontro
2525
You are about to modify electronic circuits. Improperly connecting wires can be dangerous and may damage computer equipment. We are not responsible for any harm or damage that might occur. Make sure that you understand very well how all cables should be connected. Do not install this tool if you are not absolutely sure what you are doing.
2626

2727
## Getting started
28+
Full documentation is available [here](https://powersensor3.readthedocs.io/). To get started:
2829

2930
1. Clone this repository including submodules: `git clone https://github.com/nlesc-recruit/PowerSensor3 --recurse-submodules`. If you have alread cloned the repository without submodules, run the following in the root of the repository: `git submodule init; git submodule update`.
30-
2. [Installation of the physical device and firwmare](docs/INSTALLATION_DEVICE.md)
31-
3. [Installation of the host library](docs/INSTALLATION_HOST.md)
32-
4. [PowerSensor configuration](docs/CONFIGURATION.md)
33-
5. [PowerSensor user guide](docs/USERGUIDE.md)
31+
2. [Installation of the physical device and firwmare](https://powersensor3.readthedocs.io/en/latest/INSTALLATION_DEVICE.html)
32+
3. [Installation of the host library](https://powersensor3.readthedocs.io/en/latest/INSTALLATION_HOST.html)
33+
4. [PowerSensor configuration](https://powersensor3.readthedocs.io/en/latest/CONFIGURATION.html)
34+
5. [PowerSensor user guide](https://powersensor3.readthedocs.io/en/latest/USERGUIDE.html)
3435

3536
## Further reading
3637

@@ -44,4 +45,4 @@ Altering the firmware of the device could be necessary in certain use cases. For
4445

4546
## Contributing
4647

47-
If you have a question, found a bug, or want to contribute to the development of PowerSensor3, please have a look at the [contribution guidelines](docs/CONTRIBUTING.md)
48+
If you have a question, found a bug, or want to contribute to the development of PowerSensor3, please have a look at the [contribution guidelines](https://powersensor3.readthedocs.io/en/latest/CONTRIBUTING.html)

0 commit comments

Comments
 (0)