Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fsprojects/ProjectScaffold
A prototypical .NET solution (file system layout and tooling), recommended for F# projects
https://github.com/fsprojects/ProjectScaffold
Last synced: 3 months ago
JSON representation
A prototypical .NET solution (file system layout and tooling), recommended for F# projects
- Host: GitHub
- URL: https://github.com/fsprojects/ProjectScaffold
- Owner: fsprojects
- License: unlicense
- Created: 2013-10-19T19:09:52.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T22:27:02.000Z (over 1 year ago)
- Last Synced: 2024-07-31T18:18:05.094Z (5 months ago)
- Language: F#
- Homepage: http://fsprojects.github.io/ProjectScaffold
- Size: 1.92 MB
- Stars: 516
- Watchers: 51
- Forks: 153
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-csharp - ProjectScaffold - A prototypical .NET solution recommended by the F# Foundation---includes file system setup, Paket for dependencies and FAKE for build/test automation. By default, build process also compiles documentation and generates NuGet packages. (Application Templates)
- awesome-dotnet-cn - ProjectScaffold - F# 基金会推荐的 .NET 解决方案的原型——包括文件系统的搭建、用于管理依赖的 Paket 以及用于自动化构建、测试的 FAKE。默认情况下，构建流程也会对文档进行编译，并生成 NuGet 程序包。 (应用模板)
- awesome-dotnet - ProjectScaffold - A prototypical .NET solution recommended by the F# Foundation---includes file system setup, Paket for dependencies and FAKE for build/test automation. By default, build process also compiles documentation and generates NuGet packages. (Application Templates)
- awesome-dotnet - ProjectScaffold - A prototypical .NET solution recommended by the F# Foundation---includes file system setup, Paket for dependencies and FAKE for build/test automation. By default, build process also compiles documentation and generates NuGet packages. (Application Templates)
- awesome-dot-dev - ProjectScaffold - A prototypical .NET solution recommended by the F# Foundation---includes file system setup, Paket for dependencies and FAKE for build/test automation. By default, build process also compiles documentation and generates NuGet packages. (Application Templates)
- awsome-dotnet - ProjectScaffold - A prototypical .NET solution recommended by the F# Foundation---includes file system setup, Paket for dependencies and FAKE for build/test automation. By default, build process also compiles documentation and generates NuGet packages. (Application Templates)
- awesome-dotnet - ProjectScaffold - A prototypical .NET solution recommended by the F# Foundation---includes file system setup, Paket for dependencies and FAKE for build/test automation. By default, build process also compiles documentation and generates NuGet packages. (Application Templates)
README
[](http://issuestats.com/github/fsprojects/ProjectScaffold)
[](http://issuestats.com/github/fsprojects/ProjectScaffold)
# ProjectScaffold
This project can be used to scaffold a prototypical .NET solution including file system layout and tooling. This includes a build process that:
* updates all AssemblyInfo files
* compiles the application and runs all test projects
* generates API docs based on XML document tags
* generates [documentation based on Markdown files](http://fsprojects.github.io/ProjectScaffold/writing-docs.html)
* generates [NuGet](http://www.nuget.org) packages
* and allows a simple [one step release process](http://fsprojects.github.io/ProjectScaffold/release-process.html).
In order to start the scaffolding process run
> build.cmd // on windows
$ ./build.sh // on unix
Read the [Getting started tutorial](http://fsprojects.github.io/ProjectScaffold/index.html#Getting-started) to learn more.
Documentation: http://fsprojects.github.io/ProjectScaffold
## Tips for migrating existing project to Scaffold format
* clone ProjectScaffold to new folder
* run the initializing build
* delete .git folder
* copy intitialized scaffold files and folders to original project folder
* git add / commit project -m"first pass migrating to scaffold format" (otherwise git may be confused by next mv)
* git mv necessary project file folders into src folder
* git commit, and any following cleanup
Be sure to do only ````git mv```` file renames in a single commit. If you try to commit anything else git will treat the renames as file delete / file add and you will loose history on those files.
## Requirements
ProjectScaffold requires a local git installation. You can download git from [Git Downloads](https://git-scm.com/downloads).
## Build Status
Mono | .NET
---- | ----
[](https://travis-ci.org/fsprojects/ProjectScaffold) | [](https://ci.appveyor.com/project/fsgit/projectscaffold)
## Maintainer(s)
- [@forki](https://github.com/forki)
- [@jackfoxy](https://github.com/jackfoxy)
- [@sergey-tihon](https://github.com/sergey-tihon)
The default maintainer account for projects under "fsprojects" is [@fsprojectsgit](https://github.com/fsprojectsgit) - F# Community Project Incubation Space (repo management)