Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Obscure documentation #281

Open
cargoge opened this issue Dec 16, 2016 · 1 comment
Open

Obscure documentation #281

cargoge opened this issue Dec 16, 2016 · 1 comment

Comments

@cargoge
Copy link

cargoge commented Dec 16, 2016

Description

The documentation state that the user need to produce update one or two project file without sayng what should be modified and why.

src : NOTE: When you add projects to this directory, you will need to edit build.fsx and/or generate.fsx. You will also need to update your .sln file(s).

reach the page that documents the (structure of a scaffolded project)[http://fsprojects.github.io/ProjectScaffold/structure.html]

@katepaulk
Copy link

Seconded: I did what a normal visual studio user would do to add a project to the scaffold: browsed to the existing project via VS and connected them. Nothing I did could get the documentation for the added projects generating.

What eventually worked was this:

  • Copy each existing project to the \src\ directory because it's easier than trying to retrofit the scaffold to an existing project.
  • Use Visual Studio to add the project to the solution.
  • Manually edit the XML of each .fsproj file added to correct the package links.
  • Remove and re-add any project references that weren't correct

After this I got my build running and my documentation generated.

Please consider updating the documentation on adding projects to the scaffold (new projects and existing projects) because it will save a lot of wasted time for newcomers to the project scaffold.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants