From 4d0b5832b4e8ad7c5d8310b712153ccdc06e2c32 Mon Sep 17 00:00:00 2001 From: 2881099 <2881099@qq.com> Date: Thu, 24 Oct 2024 13:10:51 +0800 Subject: [PATCH] update readme --- README.md | 2 +- docs/.gitignore | 15 ---- docs/README.md | 14 --- docs/api/index.md | 2 - docs/docfx.json | 142 ------------------------------- docs/freesql/provider/index.md | 0 docs/freesql/repository/index.md | 2 - docs/images/logo.svg | 104 ---------------------- docs/index.md | 11 --- docs/toc.yml | 11 --- 10 files changed, 1 insertion(+), 302 deletions(-) delete mode 100644 docs/.gitignore delete mode 100644 docs/README.md delete mode 100644 docs/api/index.md delete mode 100644 docs/docfx.json delete mode 100644 docs/freesql/provider/index.md delete mode 100644 docs/freesql/repository/index.md delete mode 100644 docs/images/logo.svg delete mode 100644 docs/index.md delete mode 100644 docs/toc.yml diff --git a/README.md b/README.md index f93f85795..e27e2db7f 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ QQ Groups：**561616019(available)**、4336577(full)、8578575(full)、52508226( | - | | [Get started](https://github.com/dotnetcore/FreeSql/wiki/Getting-Started)  \|  [Select](https://github.com/dotnetcore/FreeSql/wiki/Query-Data)  \|  [Update](https://github.com/dotnetcore/FreeSql/wiki/Update-Data)  \|  [Insert](https://github.com/dotnetcore/FreeSql/wiki/Insert-Data)  \|  [Delete](https://github.com/dotnetcore/FreeSql/wiki/Delete-Data)  \|  [FAQ](https://github.com/dotnetcore/FreeSql/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)  | | [Expression](https://github.com/dotnetcore/FreeSql/wiki/%e8%a1%a8%e8%be%be%e5%bc%8f%e5%87%bd%e6%95%b0)  \|  [CodeFirst](https://github.com/dotnetcore/FreeSql/wiki/CodeFirst)  \|  [DbFirst](https://github.com/2881099/FreeSql/wiki/DbFirst)  \|  [Filters](https://github.com/dotnetcore/FreeSql/wiki/%e8%bf%87%e6%bb%a4%e5%99%a8)  \|  [AOP](https://github.com/2881099/FreeSql/wiki/AOP)  | -| [Repository](https://github.com/dotnetcore/FreeSql/wiki/Repository-layer)  \|  [UnitOfWork](https://github.com/dotnetcore/FreeSql/wiki/Unit-of-Work)  \|  [DbContext](https://github.com/dotnetcore/FreeSql/wiki/DbContext)  \|  [ADO](https://github.com/2881099/FreeSql/wiki/ADO)  | +| [Repository](https://github.com/dotnetcore/FreeSql/wiki/Repository-layer)  \|  [UnitOfWork](https://github.com/dotnetcore/FreeSql/wiki/Unit-of-Work)  \|  [Dynamic Operations](https://github.com/dotnetcore/FreeSql/wiki/%E5%8A%A8%E6%80%81%E6%93%8D%E4%BD%9C)  \|  [ADO](https://github.com/2881099/FreeSql/wiki/ADO)  | | [Read/Write](https://github.com/dotnetcore/FreeSql/wiki/%e8%af%bb%e5%86%99%e5%88%86%e7%a6%bb)  \|  [Splitting Table](https://github.com/dotnetcore/FreeSql/wiki/%e5%88%86%e8%a1%a8%e5%88%86%e5%ba%93)  \|  [Hide tech](https://github.com/dotnetcore/FreeSql/wiki/%E9%AA%9A%E6%93%8D%E4%BD%9C)  \|  [*Update Notes*](https://github.com/dotnetcore/FreeSql/wiki/%e6%9b%b4%e6%96%b0%e6%97%a5%e5%bf%97)  | > Please select a development mode: diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index d5705ab89..000000000 --- a/docs/.gitignore +++ /dev/null @@ -1,15 +0,0 @@ -############### -# folder # -############### -/**/DROP/ -/**/TEMP/ -/**/packages/ -/**/bin/ -/**/obj/ -_site -/freesql/provider/*.yml -/freesql/provider/.manifest -/freesql/repository/*.yml -/freesql/repository/.manifest -/api/*.yml -/api/.manifest \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index df64eec7b..000000000 --- a/docs/README.md +++ /dev/null @@ -1,14 +0,0 @@ - -### DocFX -- https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html - - -run - -``` -docfx docfx_project\docfx.json --serve - -or - -docfx .\docfx.json --serve -``` \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md deleted file mode 100644 index 22d15855f..000000000 --- a/docs/api/index.md +++ /dev/null @@ -1,2 +0,0 @@ -# FreeSql -TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/docs/docfx.json b/docs/docfx.json deleted file mode 100644 index df093dcca..000000000 --- a/docs/docfx.json +++ /dev/null @@ -1,142 +0,0 @@ -{ - "metadata": [ - { - "src": [ - { - "files": [ - "FreeSql/*.csproj" - ], - "exclude": [ - "**/bin/**", - "**/obj/**" - ], - "src": "../" - } - ], - "dest": "api", - "disableGitFeatures": false, - "disableDefaultFilter": false - }, - { - "src": [ - { - "files": [ - "FreeSql.DbContext/*.csproj", - "FreeSql.Repository/*.csproj" - ], - "exclude": [ - "**/bin/**", - "**/obj/**" - ], - "src": "../" - } - ], - "dest": "freesql/repository", - "disableGitFeatures": false, - "disableDefaultFilter": false - }, - { - "src": [ - { - "files": [ - "Providers/FreeSql.Provider.ClickHouse/*.csproj", - "Providers/FreeSql.Provider.Dameng/*.csproj", - "Providers/FreeSql.Provider.Custom/*.csproj", - "Providers/FreeSql.Provider.Firebird/*.csproj", - "Providers/FreeSql.Provider.GBase/*.csproj", - "Providers/FreeSql.Provider.KingbaseES/*.csproj", - "Providers/FreeSql.Provider.MsAccess/*.csproj", - "Providers/FreeSql.Provider.MySql/*.csproj", - "Providers/FreeSql.Provider.MySqlConnector/*.csproj", - "Providers/FreeSql.Provider.Odbc/*.csproj", - "Providers/FreeSql.Provider.Oracle/*.csproj", - "Providers/FreeSql.Provider.PostgreSQL/*.csproj", - "Providers/FreeSql.Provider.ShenTong*.csproj", - "Providers/FreeSql.Provider.SqlServer/*.csproj", - "Providers/FreeSql.Provider.SqlServerForSystem/*.csproj", - "Providers/FreeSql.Provider.Sqlite/*.csproj", - "Providers/FreeSql.Provider.SqliteCore/*.csproj" - ], - "exclude": [ - "**/bin/**", - "**/obj/**" - ], - "src": "../" - } - ], - "dest": "freesql/provider", - "disableGitFeatures": false, - "disableDefaultFilter": false - } - ], - "build": { - "content": [ - { - "files": [ - "api/**.yml", - "api/index.md" - ] - }, - { - "files": [ - "freesql/repository/**.yml", - "freesql/repository/index.md" - ] - }, - { - "files": [ - "freesql/provider/**.yml", - "freesql/provider/index.md" - ] - }, - { - "files": [ - "articles/**.md", - "articles/**/toc.yml", - "toc.yml", - "*.md" - ] - } - ], - "resource": [ - { - "files": [ - "images/**", - "styles/**" - ] - } - ], - "overwrite": [ - { - "files": [ - "Docs/**.md" - ], - "exclude": [ - "obj/**", - "_site/**" - ] - } - ], - "dest": "_site", - "globalMetadataFiles": [], - "fileMetadataFiles": [], - "template": [ - "default" - ], - "globalMetadata": { - "_appTitle": "FreeSql API Docs", - "_appLogoPath": "./images/logo.svg", - "_gitContribute": { - "repo": "https://github.com/dotnetcore/freesql", - "branch": "master" - }, - "_enableSearch": true - }, - "postProcessors": [], - "markdownEngineName": "markdig", - "noLangKeyword": false, - "keepFileLink": false, - "cleanupCacheHistory": false, - "disableGitFeatures": false - } -} diff --git a/docs/freesql/provider/index.md b/docs/freesql/provider/index.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/freesql/repository/index.md b/docs/freesql/repository/index.md deleted file mode 100644 index 726a58de0..000000000 --- a/docs/freesql/repository/index.md +++ /dev/null @@ -1,2 +0,0 @@ -# repository -TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/docs/images/logo.svg b/docs/images/logo.svg deleted file mode 100644 index 0af3c5728..000000000 --- a/docs/images/logo.svg +++ /dev/null @@ -1,104 +0,0 @@ - - - - diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index f63cb3c64..000000000 --- a/docs/index.md +++ /dev/null @@ -1,11 +0,0 @@ - -# FreeSql Document - -#### [http://freesql.net](http://freesql.net) - - - - .NET orm, Mysql orm, Postgresql orm, SqlServer orm, Oracle orm, Sqlite orm, Firebird orm, 达梦 orm, 人大金仓 orm, 神通 orm, MsAccess orm. - - - Github [https://github.com/dotnetcore/freesql](https://github.com/dotnetcore/freesql) - - Gitee [https://gitee.com/FreeSql/FreeSql-ORM](https://gitee.com/FreeSql/FreeSql-ORM) diff --git a/docs/toc.yml b/docs/toc.yml deleted file mode 100644 index e9b1d9621..000000000 --- a/docs/toc.yml +++ /dev/null @@ -1,11 +0,0 @@ -- name: FreeSql Documentation - href: api/ - homepage: api/index.md - -- name: Repository Documentation - href: freesql/repository/ - homepage: freesql/repository/index.md - -- name: Provider Documentation - href: freesql/provider/ - homepage: freesql/provider/index.md