Skip to content

Commit

Permalink
Adding a bit of docs - references #105
Browse files Browse the repository at this point in the history
  • Loading branch information
forki committed Sep 16, 2014
1 parent 37c9a06 commit 47140aa
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
18 changes: 17 additions & 1 deletion docs/content/convert_from_nuget.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
# Convert your solution from NuGet

## Manual process

If you are already using `NuGet.exe` for package restore then it should be easy to convert to Paket.

1. Analyse your `packages.config` files and extract the referenced packages into a [paket.dependencies](dependencies_file.html) file.
2. Convert every `packages.config` file to [paket.references](references_files.html) syntax. This is very easy - you just have to remove all the XML and keep the package names.
3. Run [paket install](paket_install.html) with the `--hard` flag. This will analyze the dependencies, generate a [paket.lock](lock_file.html) file and remove all the old package references from your project files and install new references in Paket's syntax.
3. Run [paket install](paket_install.html) with the `--hard` flag. This will analyze the dependencies, generate a [paket.lock](lock_file.html) file and remove all the old package references from your project files and install new references in Paket's syntax.

<div id="automatic"></div>
## Automatic process

Paket can assist you with the conversion. The `convert-from-nuget` command finds all `packages.config` files and based on them generates a [paket.dependencies](dependencies_file.html) file and converts them to [paket.references](references_files.html).
If the `packages.config` is solution-level, then its dependencies will be written to [paket.dependencies](dependencies_file.html) and it will be removed.
Afterwards it will run the [paket install](paket_install.html) process with the `--hard` flag. This will analyze the dependencies, generate a [paket.lock](lock_file.html) file and remove all the old package references from your project files and install new references in Paket's syntax.

[lang=batchfile]
$ paket convert-from-nuget [--dependencies-file=FILE]

Options:

`--dependencies-file`: Use the specified file instead of [`paket.dependencies`](dependencies_file.html).
2 changes: 1 addition & 1 deletion docs/tools/templates/template.cshtml
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@
<li><a href="@Root/dependencies_file.html">paket.dependencies</a></li>
<li><a href="@Root/lock_file.html">paket.lock</a></li>
<li><a href="@Root/references_files.html">paket.references</a></li>
<li><a href="@Root/convert_from_nuget.html">Convert from NuGet</a></li>
<li><a href="@Root/reference/index.html">API Reference</a></li>

<li class="nav-header">Paket commands</li>
<li><a href="@Root/paket_install.html">paket install</a></li>
<li><a href="@Root/paket_outdated.html">paket outdated</a></li>
<li><a href="@Root/paket_update.html">paket update</a></li>
<li><a href="@Root/convert_from_nuget.html">paket convert-from-nuget</a></li>
</ul>
</div>
</div>
Expand Down

0 comments on commit 47140aa

Please sign in to comment.