-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed misplaced file and updated the index files
- Loading branch information
1 parent
20b58f2
commit f76f2c0
Showing
3 changed files
with
22 additions
and
42 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,23 @@ | ||
| Documentation | ||
| # Documentation | ||
| There are 4 categories of documentation, the first is for users of the GUI and provides educational resources regarding the underlying solution methods, the second is for users of the Monte Carlo Command Line (MCCL) application, the third is for Windows MATLAB users to access the VTS libraries using the VTS MATLAB Package, and the fourth is for developers wishing to access and/or modify the source code. | ||
|
|
||
| VTS GUI Documentation | ||
| ## VTS GUI Documentation | ||
| * [Description of the panels in the GUI Application](https://github.com/VirtualPhotonics/Vts.Gui.Wpf/wiki/Software) | ||
| * [Video Walkthroughs of the GUI Application]() | ||
| * [Video Walkthroughs of the GUI Application](https://virtualphotonics.org/video) | ||
|
|
||
| Documentation for Monte Carlo Command Line (MCCL) Application | ||
| * [Editing Monte Carlo Command Line infiles]() | ||
| * [Running MCCL]() | ||
| * [Capabilities and Implementation of Conventional Monte Carlo]() | ||
| ## Documentation for Monte Carlo Command Line (MCCL) Application | ||
| * [Editing Monte Carlo Command Line infiles](https://github.com/VirtualPhotonics/Vts.MonteCarlo/wiki/MCCL-Editing-infiles) | ||
| * [Running MCCL](https://github.com/VirtualPhotonics/Vts.MonteCarlo/wiki/MCCL-Examples) | ||
| * [Capabilities and Implementation of Conventional Monte Carlo](https://github.com/VirtualPhotonics/Vts.MonteCarlo/wiki/MCCL-Capabilities-And-Implementation) | ||
|
|
||
| Documentation for VTS MATLAB Package | ||
| * [Getting Started with MATLAB]() | ||
| ## Documentation for VTS MATLAB Package | ||
| * [Getting Started with MATLAB](https://github.com/VirtualPhotonics/VTS/wiki/VTS-MATLAB) | ||
|
|
||
| Instructions for VTS Source Code Download and Use | ||
| * [Getting Started (Linux, Mac, Windows)]() | ||
| * [Coding Conventions]() | ||
| * [Compiling and running the VTS]() | ||
| * [Build, Test and Run the VTS without Visual Studio]() | ||
| * [Documenting Source Code]() | ||
| * [Adding a New Forward Solver]() | ||
| * [MSDN Style Developer Documentation]() | ||
| ## 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) | ||
| * [MSDN Style Developer Documentation (CHM File)](https://github.com/VirtualPhotonics/VTS/releases/download/Version_8.0/VtsDocumentation.chm) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,5 @@ | ||
| # PLACEHOLDER | ||
| TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! | ||
| # 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) |