Skip to content

Commit bdc06fe

Browse files
committed
Add warning about Paket to documentation.
1 parent 39bfbc1 commit bdc06fe

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

doc/Tutorial/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ Install-Package Rezoom.SQL.Provider.SQLite
3030

3131
This will add Rezoom.SQL and its dependencies to your project, along with a few files to help you get started.
3232

33+
If you are using [Paket](http://fsprojects.github.io/Paket) instead of NuGet,
34+
see the **important** note for Paket users [at the bottom of this page](#note-for-paket-users).
35+
3336
## Setting up your database model
3437

3538
One of the files automatically added to your project is `V1.model.sql`. Take a look inside and you'll see
@@ -196,6 +199,23 @@ let main argv =
196199
0
197200
```
198201

202+
## Note for Paket users
203+
204+
The package `Rezoom.SQL.Provider.SQLite` includes sample configuration files to
205+
help you get started. These include V1.model.sql and rzsql.json.
206+
207+
When you update using NuGet, if you changed these files, it'll ask you before
208+
overwriting them. You will probably want to answer "no" to this question.
209+
210+
If you are using [Paket](https://fsprojects.github.io/Paket/), watch out. It
211+
will _not_ ask and will overwrite these files every time you update or restore
212+
packages. This is definitely not what you want! So if you are using Paket,
213+
either:
199214

215+
* Just use Rezoom.SQL.Provider and create the configuration files yourself by
216+
referring to the [configuration](../Configuration/README.md) section of this
217+
manual. Once you've seen the examples it's not difficult.
200218

219+
* Or use `nuget Rezoom.SQL.Provider.SQLite content: once` so the configuration
220+
files get installed the first time, but never overwritten.
201221

0 commit comments

Comments
 (0)