diff --git a/README.md b/README.md index 9198e75a29..567c3f61aa 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,38 @@ # ABP -ABP is a modern application development framework based on cross platform .Net Core framework. +ABP is a modern application development platform based on cross platform .Net Core framework. See documentation. + +### How to Build + +- Run the `build-all.ps1`. It will build all the solutions in this repository. + +### Development + +#### Pre Requirements + +- Visual Studio 2017 15.7.0+ + +#### Framework + +Framework solution is located under the `framework` folder. It has no external dependency. Just open `Volo.Abp.sln` by Visual Studio and start the development. + +#### Modules/Templates + +[Modules](modules/) and [Templates](templates/) have their own solutions and have **local references** to the framework. Unfortunately, Visual Studio has some problems with local references to projects those are out of the solution. As a workaround, you should follow the steps below in order to start developing a module/template: + +- Disable "*Automatically check for missing packages during build in Visual Studio*" in the Visual Studio options. + +![disable-package-restore-visual-studio](D:/Github/volo/docs/images/disable-package-restore-visual-studio.png) + +- When you open a solution, first run `dotnet restore` in the root folder of the solution. +- When you change a dependency of a project (or any of the dependencies of your projects change their dependencies), run `dotnet restore` again. + +### Contribution + +ABP is an open source platform. + +* Open a [new issue](https://github.com/volosoft/volo/issues/new) if you found a bug or if you have a new feature/enhancement idea. +* Open a pull request if you want to make a development. Please create an issue before a development, so we can discuss it. +* Contribute to the [documentation](docs/Index.md). \ No newline at end of file diff --git a/docs/images/disable-package-restore-visual-studio.png b/docs/images/disable-package-restore-visual-studio.png new file mode 100644 index 0000000000..5d2343dc3f Binary files /dev/null and b/docs/images/disable-package-restore-visual-studio.png differ