Skip to content

Commit ba2f656

Browse files
committed
Update CONTRIBUTING.md
Updated the CONTRIBUTING.md, based on GitHub requests; moved the information on how to build below enhancing documentation, and added how to view it.
1 parent f46433d commit ba2f656

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ If VTR does not support your use case, consider [filling an enhancement](#fillin
2929
Great! Submitting bug-fixes and features is a great way to improve VTR.
3030
See the guidlines for [submitting code](#submitting-code-to-vtr).
3131

32-
### How do I build the documentation?
33-
The documentation can be built by using the command `make html` in the `$VTR_ROOT/doc` directory. More information on building
34-
the document can be found on the [README on the GitHub](https://github.com/verilog-to-routing/vtr-verilog-to-routing/tree/master/doc).
35-
3632
## The Details
3733

3834
### Enhancing Documentation
@@ -45,6 +41,9 @@ If you are considering larger changes its best to discuss them first (e.g. file
4541

4642
Once you've made your enhancements [open a pull request](#making-pull-requests) to get your changes considered for inclusion in the documentation.
4743

44+
### How do I build the documentation?
45+
The documentation can be built by using the command `make html` in the `$VTR_ROOT/doc` directory and you can view it in a web browser by loading the file at $VTR_ROOT/_build/html/index.html. More information on building
46+
the documentation can be found on the [README on GitHub](https://github.com/verilog-to-routing/vtr-verilog-to-routing/tree/master/doc).
4847

4948
### Filling Bug Reports
5049
First, search for [existing issues](https://github.com/verilog-to-routing/vtr-verilog-to-routing/issues?&=) to see if the bug has already been reported.

0 commit comments

Comments
 (0)