Skip to content
This repository was archived by the owner on Dec 29, 2024. It is now read-only.

Commit 4ec644e

Browse files
author
Michieal
authored
Dot net doc update (#188)
1 parent 48b0006 commit 4ec644e

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

DOTNET.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In your command prompt, execute these commands in the following order.
4646

4747
`dotnet nuget locals all --clear`
4848

49-
`dotnet nuget add source /path/to/nuget_packages/ --name LuaAPINugetSource`
49+
`dotnet nuget add source /path/to/nuget_packages --name LuaAPINugetSource`
5050

5151
`dotnet restore '/pathtoproject/example_project.csproj' -f -s LuaAPINugetSource`
5252

@@ -65,6 +65,33 @@ local sources first in the list, this will ensure that they are put in, and that
6565
A note on the LuaAPI specific nuget packages: They are included in the Mono (DotNet) builds from the `Releases` tab on
6666
the Github page.
6767

68+
Additional help with the Nuget Packages installation:
69+
In some cases the packages will fail to restore, and if that happens to you, this is something that you can do to try
70+
to make it work. You will need to remove the existing `LuaAPINugetSource` that you made above, and then put this file
71+
in your project directory. As it uses an absolute path, others will need to change it to their location, if they are
72+
part of your team. (Like an open source project, or if they are compiling the code themselves.)
73+
* Create a nuget.config file in the root of your project or solution (if it doesn't already exist).
74+
* Open or create the nuget.config file, and add the following:
75+
76+
```xml
77+
<?xml version="1.0" encoding="utf-8"?>
78+
<configuration>
79+
<packageSources>
80+
<add key="LuaAPINugetSource" value="/path/to/editor/editor-mono/nuget_packages" />
81+
<!-- Add other package sources if needed -->
82+
</packageSources>
83+
</configuration>
84+
```
85+
86+
* Replace `/path/to/editor/editor-mono/nuget_packages` with the correct path to your local NuGet source. Note the
87+
lack of a trailing slash.
88+
* Save the nuget.config file.
89+
90+
With this configuration, the NuGet restore process will automatically consider the sources listed in the nuget.config.
91+
Note that windows users may have other issues with dotnet, files being marked unsafe because they originated from other
92+
computers, not being done as an administrator, etc. Sadly, those are on the user to fix as it is beyond the scope of a
93+
getting started file.
94+
6895
Getting Started Example (In C#)
6996
-------
7097

0 commit comments

Comments
 (0)