diff --git a/README.md b/README.md index 72a47ddc4b..9dffe69012 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,23 @@ -# ABP +# ABP Framework ![build and test](https://github.com/abpframework/abp/workflows/build%20and%20test/badge.svg) [![NuGet](https://img.shields.io/nuget/v/Volo.Abp.Core.svg?style=flat-square)](https://www.nuget.org/packages/Volo.Abp.Core) [![MyGet (with prereleases)](https://img.shields.io/myget/abp-nightly/vpre/Volo.Abp.svg?style=flat-square)](https://docs.abp.io/en/abp/latest/Nightly-Builds) [![NuGet Download](https://img.shields.io/nuget/dt/Volo.Abp.Core.svg?style=flat-square)](https://www.nuget.org/packages/Volo.Abp.Core) -This project is the next generation of the [ASP.NET Boilerplate](https://aspnetboilerplate.com/) web application framework. See [the announcement](https://blog.abp.io/abp/Abp-vNext-Announcement). +ABP is an **open source application framework** focused on ASP.NET Core based web application development, but also supports developing other type of applications. -See the official [web site (abp.io)](https://abp.io/) for more information. +## Links -### Documentation +* Official Web Site + * Get Started + * Features + * Documentation + * Samples + * Blog +* Stack overflow +* Twitter -See the documentation. - -### Development - -#### Pre Requirements - -- Visual Studio 2019 16.4.0+ - -#### Framework - -Framework solution is located under the `framework` folder. It has no external dependency. - -#### Modules/Templates - -[Modules](modules/) and [Templates](templates/) have their own solutions and have **local references** to the framework and each other. - -Visual Studio can not work properly with the local references out of the solution folder. When you open a module/sample solution in the Visual Studio, you may get some errors related to the dependencies. In this case, run the `dotnet restore` on the command prompt for the related solution's folder. You need to run it after you first open the solution or change a dependency. - -### Contribution +## Contribution ABP is an open source platform. Check [the contribution guide](docs/en/Contribution/Index.md) if you want to contribute to the project. diff --git a/docs/en/Index.md b/docs/en/Index.md index 7dc2b56da0..8eeb7aeb72 100644 --- a/docs/en/Index.md +++ b/docs/en/Index.md @@ -1,6 +1,6 @@ # ABP Documentation -ABP is an **open source application framework** focused on ASP.NET Core based web application development, but also supports developing other types of applications. +ABP is an **open source application framework** focused on ASP.NET Core based web application development, but also supports developing other type of applications. Explore the left navigation menu to deep dive in the documentation. @@ -16,6 +16,10 @@ If you want to start from scratch (with an empty project) then manually install * [Console Application](Getting-Started-Console-Application.md) * [ASP.NET Core Web Application](Getting-Started-AspNetCore-Application.md) +## Packages + +ABP Framework is distributed as NuGet and NPM packages. See [this page](http://abp.io/packages) for the complete list of the packages. + ## Source Code ABP is hosted on GitHub. See [the source code](https://github.com/abpframework/abp).