Docs: Create a proper readme

[Alxandr]

No description provided.

[jwood803]

Just curious...what help is all needed here?

[Alxandr]

Hmm. "help needed" is sort of strong. The point is, I create terrible documentation, and would really like if somebody else could do that part :P.

[jwood803]

I'll be glad to help, though not exactly sure how to get started using this, if that makes sense. :]

[Alxandr]

@jwood803 quick samples are in the samples directory. The short version is that you need only a few things to get started:

1. Reference the nuget feed https://www.myget.org/F/fsprojects/api/v3/index.json in NuGet.Config (casing matters in the filename btw).
2. Add FSharp.Dnx as a dependency, and set it as the compiler (see https://github.com/fsprojects/fsharp-dnx/blob/318a4a8b044d1f07f952cb4066e3480dfeed246a/sample/HelloFSharp/project.json for the simplest sample, only thing that need to change is that version of FSharp.Dnx needs to be 1.0.0-* instead of just empty string).
3. Add the F# file list to the project.json (again, see sample).

That's what you need to get up and running. Now, I should probably write a real quick README, detailing those points I just gave you (and might even do so eventually), but I would really like a solid writeup with a bit more details and explanations.

[jwood803]

I can do that and write down those steps with screenshots at the very least.

[jwood803]

@Alxandr For the project type, would one need to create just an F# Library and then add the items from above or is there another project type that must be used?

[Alxandr]

Actually, you don't need to involve Visual Studio at all. What I tend to do is to create a FSproj (to get some tooling), and then do all of the DNX stuff outside of visual studio. If you want to go the visual studio route of DNX project, it's this one:

Though, you'll get absolutely no F# tooling by going that route.

[jwood803]

Thanks @Alxandr! I think I have an idea to set it up. Just now getting started with this new ASP.NET 5 stuff so it's still a bit confusing. 😺

Good thing is, I can put all of what I do in the README.

[dbwz8]

Maybe off topic (but should be somewhere in the docs)... how do you define a compile time constant? I tried to add a to the Globals PropertyGroup in the .xproj file.. but it appears to be ignored. Suggestions?