Skip to content

Commit

Permalink
doc: create a README
Browse files Browse the repository at this point in the history
  • Loading branch information
everythingfunctional committed Jun 2, 2021
1 parent 8150d7b commit 1843a98
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Fortran Package Manager for Visual Studio (fpm for VS)

This extension adds options and menu entries for building, running and testing your Fortran project using the [Fortran Package Manager (fpm)](https://github.com/fortran-lang/fpm).

## Usage

In the Tools->Options dialog, find the entry "fpm Options", and specify the appropriate values for the various options.
Note that leaving an option blank is valid, as it means the extension will simply not include that in the options passed to fpm, and thus fpm will simply use the default.
Use one of the entries in the Extensions->fpm menu to execute `fpm build`, `fpm run` or `fpm test`, using the options specified in the previous step.

## Contributing

For background material and getting started, I found [this video](https://channel9.msdn.com/Events/Build/2016/B886) to be a great start, and of course [the official documentation](https://docs.microsoft.com/en-us/visualstudio/extensibility/starting-to-develop-visual-studio-extensions?view=vs-2019).
Please [open an issue](https://github.com/everythingfunctional/fpm-for-VS/issues/new/choose) to report a bug, or request a feature so that it can be discussed before submitting a [pull request](https://github.com/everythingfunctional/fpm-for-VS/compare).
5 changes: 5 additions & 0 deletions fpm-for-VS.sln
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ VisualStudioVersion = 16.0.31205.134
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "fpm-for-VS", "fpm-for-VS.csproj", "{BCF90366-A706-49C3-B6E9-D69A2253D31E}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{098F0810-0E43-4325-9F7D-117D13903793}"
ProjectSection(SolutionItems) = preProject
README.md = README.md
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down

0 comments on commit 1843a98

Please sign in to comment.