Skip to content

Commit

Permalink
Merge pull request #178 from VirtualPhotonics/feature/177-update-the-…
Browse files Browse the repository at this point in the history
…outdated-documentation

feature/177 update the outdated documentation
  • Loading branch information
lmalenfant authored Nov 7, 2024
2 parents 01d6bcf + 500456a commit ca3c14d
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 6 deletions.
1 change: 0 additions & 1 deletion documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ There are 4 categories of documentation, the first is for users of the GUI and p
### Instructions for VTS Source Code Download and Use
* Getting Started ([Linux](https://github.com/VirtualPhotonics/VTS/wiki/Getting-Started-on-Linux), [Mac](https://github.com/VirtualPhotonics/VTS/wiki/Getting-Started-on-Mac), [Windows](https://github.com/VirtualPhotonics/VTS/wiki/Getting-Started-in-Windows))()
* [Coding Conventions](https://github.com/VirtualPhotonics/VTS/wiki/Coding-Conventions)
* [Compiling and running the VTS](https://github.com/VirtualPhotonics/VTS/wiki/Compile-and-run-the-VTS)
* [Build, Test and Run the VTS without Visual Studio](https://github.com/VirtualPhotonics/VTS/wiki/Without-Visual-Studio)
* [Documenting Source Code](https://github.com/VirtualPhotonics/VTS/wiki/Visual-Studio-XML-Comment-Tags)
* [Adding a New Forward Solver](https://github.com/VirtualPhotonics/VTS/wiki/Adding-a-New-Forward-Solver-to-the-VTS)
Expand Down
4 changes: 1 addition & 3 deletions documentation/vts/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Developer Documentation

This documentation was generated from the XML comments within the source files. We also have a downloadable CHM file that replicates the MSDN style documentation from Microsoft.

That file can be downloaded [here](https://github.com/VirtualPhotonics/VTS/releases/download/Version_8.0/VtsDocumentation.chm)
This documentation was generated from the XML comments within the source files.
2 changes: 0 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ To access getting started instructions in Linux, Mac or Windows, click
* [Mac](https://github.com/VirtualPhotonics/VTS/wiki/Getting-Started-on-Mac)
* [Windows](https://github.com/VirtualPhotonics/VTS/wiki/Getting-Started-in-Windows)

For detailed instructions on how to launch the VTS GUI, click [here](https://github.com/VirtualPhotonics/VTS/wiki/Compile-and-run-the-VTS).

## Acknowledgement
Use the following citation or acknowledgement in publications or applications that make use of this open source software or underlying technology and research:

Expand Down

0 comments on commit ca3c14d

Please sign in to comment.