Skip to content

Commit

Permalink
more info in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
enricosada committed Oct 27, 2017
1 parent 56f1db4 commit ecbb871
Showing 1 changed file with 32 additions and 8 deletions.
40 changes: 32 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,55 @@
# dotnet-proj-info

[![Build status](https://ci.appveyor.com/api/projects/status/i7piggo87r7k31t2/branch/master?svg=true)](https://ci.appveyor.com/project/enricosada/dotnet-proj-info/branch/master)
[![Build Status](https://travis-ci.org/enricosada/dotnet-proj-info.svg?branch=master)](https://travis-ci.org/enricosada/dotnet-proj-info)

- dotnet cli tool: `dotnet proj-info` [![NuGet](https://img.shields.io/nuget/v/dotnet-proj-info.svg)](https://www.nuget.org/packages/dotnet-proj-info)
# dotnet-proj-info

- as library: `Dotnet.ProjInfo` [![NuGet](https://img.shields.io/nuget/v/Dotnet.ProjInfo.svg)](https://www.nuget.org/packages/Dotnet.ProjInfo)
- dotnet cli tool: `dotnet proj-info` [![NuGet](https://img.shields.io/nuget/v/dotnet-proj-info.svg)](https://www.nuget.org/packages/dotnet-proj-info)

Features:
## Features

- get properties
- get project to project references
- get fsc command line arguments
- list installed .NET Framework versions
- get references path of .NET asseblies like `System`, `System.Data`

Support:
Support both project sdk:

- dotnet/sdk style projects (slim proj, usually .net core)
- old sdk projects (verbose proj, usually .NET)

Runtimes:

Works on mono and windows, and allow to specify the `dotnet` or `msbuild` to use

Notes:
## as Library

Used by:

- [Fable compiler](https://github.com/fable-compiler/fable) to parse fsproj projects with `dotnet fable`
- [FsAutocomplete (FSAC)](https://github.com/fsharp/FsAutoComplete/) to parse projects. That's the language server that add F# support in:
- [Ionide in Visual Studio Code](https://github.com/ionide/ionide-vscode-fsharp)
- [F# vim binding](https://github.com/fsharp/vim-fsharp)
- [F# Emacs mode](https://github.com/fsharp/emacs-fsharp-mode)

Add usual args of .NET cli, like `-c` (`--configuration`), `-f` (`--framework`), `-r` (`--runtime`)
## as .NET Cli tool

See [examples](https://github.com/enricosada/dotnet-proj-info/tree/master/examples) directory
Add

```xml
<DotNetCliToolReference Include="dotnet-proj-info" Version="*" />
```

restore, and it use as `dotnet proj-info`

Support args of .NET cli (`dotnet`), like:

- `-c` or `--configuration`
- `-f` or `--framework`
- `-r` or `--runtime`

See [examples](https://github.com/enricosada/dotnet-proj-info/tree/master/examples) directory for a quick tutorial

```
USAGE: proj-info [--help] [--fsc-args] [--project-refs] [--get-property [<string>...]]
Expand Down Expand Up @@ -66,6 +88,8 @@ OPTIONS:

## Build

Clone repo.

Run:

```bash
Expand Down

0 comments on commit ecbb871

Please sign in to comment.