From 04dd5256ef95c0ecc48e4e066e207143874e4da0 Mon Sep 17 00:00:00 2001 From: alanbu1 Date: Mon, 29 May 2023 14:57:58 -0400 Subject: [PATCH 1/4] Update CONTRIBUTING.md Added section for how to build the documentation, linking to the README file on the GitHub --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6087275290..9dc2fb43316 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,10 @@ If VTR does not support your use case, consider [filling an enhancement](#fillin Great! Submitting bug-fixes and features is a great way to improve VTR. See the guidlines for [submitting code](#submitting-code-to-vtr). +### How do I build the documentation? +The documentation can be built by using the command `make html` in the `$VTR_ROOT/doc` directory. More information on building +the document can be found on the [README on the GitHub](https://github.com/verilog-to-routing/vtr-verilog-to-routing/tree/master/doc). + ## The Details ### Enhancing Documentation From f46433dcbd203825db65a2e0703bd93f939706a3 Mon Sep 17 00:00:00 2001 From: alanbu1 Date: Tue, 30 May 2023 16:02:11 -0400 Subject: [PATCH 2/4] Update main.ui Changed done button to proceed on the UI --- vpr/main.ui | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vpr/main.ui b/vpr/main.ui index 21f78e1604f..e4f31a55d2c 100644 --- a/vpr/main.ui +++ b/vpr/main.ui @@ -650,7 +650,7 @@ - Done + Proceed True True True From ba2f656953457603ece4ae62c8dbfed510aa564c Mon Sep 17 00:00:00 2001 From: alanbu1 Date: Mon, 5 Jun 2023 16:38:07 -0400 Subject: [PATCH 3/4] 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. --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9dc2fb43316..566ae18a9a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,10 +29,6 @@ If VTR does not support your use case, consider [filling an enhancement](#fillin Great! Submitting bug-fixes and features is a great way to improve VTR. See the guidlines for [submitting code](#submitting-code-to-vtr). -### How do I build the documentation? -The documentation can be built by using the command `make html` in the `$VTR_ROOT/doc` directory. More information on building -the document can be found on the [README on the GitHub](https://github.com/verilog-to-routing/vtr-verilog-to-routing/tree/master/doc). - ## The Details ### Enhancing Documentation @@ -45,6 +41,9 @@ If you are considering larger changes its best to discuss them first (e.g. file Once you've made your enhancements [open a pull request](#making-pull-requests) to get your changes considered for inclusion in the documentation. +### How do I build the documentation? +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 +the documentation can be found on the [README on GitHub](https://github.com/verilog-to-routing/vtr-verilog-to-routing/tree/master/doc). ### Filling Bug Reports 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. From f330ba9a6a3994dec43e3bc21c40702dcfcac31a Mon Sep 17 00:00:00 2001 From: alanbu1 Date: Tue, 6 Jun 2023 14:21:04 -0400 Subject: [PATCH 4/4] Update CONTRIBUTING.md Changed the appearance of the written directory to match documentation --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 566ae18a9a0..f5030302bf9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,7 +42,7 @@ If you are considering larger changes its best to discuss them first (e.g. file Once you've made your enhancements [open a pull request](#making-pull-requests) to get your changes considered for inclusion in the documentation. ### How do I build the documentation? -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 +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 the documentation can be found on the [README on GitHub](https://github.com/verilog-to-routing/vtr-verilog-to-routing/tree/master/doc). ### Filling Bug Reports