Skip to content

Commit 2760979

Browse files
NogginBopsNogginBops
committed
Add nuget packge readme. Hopefully fixed CI building issue (ugly hack...)
1 parent b706125 commit 2760979

File tree

21 files changed

+105
-16
lines changed

21 files changed

+105
-16
lines changed

‎build/build.fs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ Target.create "Clean" <| fun _ ->
154154
-- ("./src" </> "OpenTK.Graphics" </> "Wgl/*.*")
155155
-- ("./src" </> "OpenTK.Graphics" </> "Egl/*.*")
156156
-- ("./src" </> "OpenTK.Graphics" </> "paket")
157+
-- ("./src" </> "OpenTK.Graphics" </> "README.md")
157158
|> Seq.iter(Shell.rm)
158159

159160
Target.create "Restore" (fun _ -> DotNet.restore dotnetSimple "OpenTK.sln" |> ignore)

‎src/OpenAL/OpenTK.Audio.OpenAL/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OpenTK.Audio.OpenAL
2+
3+
OpenAL bindings for dotnet from the OpenAL c library.
4+
5+
Read more about how to use OpenTK at: https://opentk.net/

‎src/OpenAL/OpenTK.Audio.OpenAL/paket‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
type file
22
id OpenTK.Audio.OpenAL
33
description
4-
OpenAL bindings for dotnet from the Khronos openAL c library.
4+
OpenAL bindings for dotnet from the OpenAL c library.
55
dependencies
66
framework: netcoreapp3.1
77
OpenTK.Core ~> #VERSION#
88
OpenTK.Mathematics ~> #VERSION#
99
files
1010
bin\Release\netcoreapp3.1\OpenTK.Audio.OpenAL.dll ==> lib\netcoreapp3.1
1111
bin\Release\netcoreapp3.1\OpenTK.Audio.OpenAL.xml ==> lib\netcoreapp3.1
12-
bin\Release\netcoreapp3.1\OpenTK.Audio.OpenAL.pdb ==> lib\netcoreapp3.1
12+
bin\Release\netcoreapp3.1\OpenTK.Audio.OpenAL.pdb ==> lib\netcoreapp3.1
13+
README.md ==> docs\README.md
14+
15+
readme
16+
docs\README.md

‎src/OpenTK.Compute/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OpenTK.Compute
2+
3+
OpenCL Compute Bindings for dotnet from the Khronos OpenCL C Library.
4+
5+
Read more about how to use OpenTK at: https://opentk.net/

‎src/OpenTK.Compute/paket‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,7 @@ files
88
bin\Release\netcoreapp3.1\OpenTK.Compute.dll ==> lib\netcoreapp3.1
99
bin\Release\netcoreapp3.1\OpenTK.Compute.xml ==> lib\netcoreapp3.1
1010
bin\Release\netcoreapp3.1\OpenTK.Compute.pdb ==> lib\netcoreapp3.1
11+
README.md ==> docs\README.md
12+
13+
readme
14+
docs\README.md

‎src/OpenTK.Core/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OpenTK.Core
2+
3+
Holds core functionality used by other OpenTK packages.
4+
5+
Read more about how to use OpenTK at: https://opentk.net/

‎src/OpenTK.Core/paket‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,8 @@ description
55
files
66
bin\Release\netstandard2.1\OpenTK.Core.dll ==> lib\netstandard2.1
77
bin\Release\netstandard2.1\OpenTK.Core.xml ==> lib\netstandard2.1
8-
bin\Release\netstandard2.1\OpenTK.Core.pdb ==> lib\netstandard2.1
8+
bin\Release\netstandard2.1\OpenTK.Core.pdb ==> lib\netstandard2.1
9+
README.md ==> docs\README.md
10+
11+
readme
12+
docs\README.md

‎src/OpenTK.Graphics/OpenTK.Graphics.csproj‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<RootNamespace>OpenTK.Graphics</RootNamespace>
66
<SignAssembly>true</SignAssembly>
77
<AssemblyOriginatorKeyFile>../../OpenTK.snk</AssemblyOriginatorKeyFile>
8-
<DelaySign>True</DelaySign>
8+
<DelaySign>true</DelaySign>
99
</PropertyGroup>
1010

1111
<!-- This article is useful for generating code: -->
@@ -25,10 +25,6 @@
2525
<ProjectReference Include="..\Generator.Rewrite\Generator.Rewrite.csproj" SkipGetTargetFrameworkProperties="true" UndefineProperties="TargetFramework" ReferenceOutputAssembly="false" ExcludeAssets="all" />
2626
</ItemGroup>
2727

28-
<ItemGroup>
29-
<PackageReference Include="Microsoft.Build.Tasks.Core" Version="17.1.0" ExcludeAssets="runtime" />
30-
</ItemGroup>
31-
3228
<!-- Define what files we depend on and which files are generated -->
3329
<ItemGroup>
3430
<GLSpec Include="..\gl.xml" />
@@ -93,15 +89,26 @@
9389
<!-- We do this in DispatchToInnerBuilds so we do this so the target is only run once in contrast to task that runs before 'Rewrite' which get run multiple times for each target framework. -->
9490
<!-- - Noggin_bops 2024-11-27 -->
9591
<Target Name="GetSNPath" BeforeTargets="Rewrite">
96-
<GetFrameworkSdkPath>
92+
<!-- FIXME: This is a BAD hack, but it's the best I've got to make "dotnet build" and AppVeyor work... Ideally we'd use GetFrameworkSdkPath but that is only available in .net framework? -->
93+
<!-- - Noggin_bops 2024-11-27 -->
94+
<PropertyGroup Condition="'$(OS)' == 'Windows_NT'">
95+
<SNPath>C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools\sn.exe</SNPath>
96+
</PropertyGroup>
97+
<!-- FIXME: This is untested on both macOS and Linux, no idea if it works... -->
98+
<!-- - Noggin_bops 2024-11-27 -->
99+
<PropertyGroup Condition="'$(OS)' != 'Windows_NT'">
100+
<SNPath>/usr/bin/sn</SNPath>
101+
</PropertyGroup>
102+
<Error Text="Could not find path to sn.exe (FIXME: for now this path is hardcoded). You will likely need to modify the csproj to get the build working." Condition="!Exists($(SNPath))" />
103+
<!--<GetFrameworkSdkPath>
97104
<Output TaskParameter="Path" PropertyName="WindowsSdkPath" />
98105
</GetFrameworkSdkPath>
99106
<Exec Command=":; echo sn; exit $?&#xD;&#xA;WHERE /r &quot;$(WindowsSdkPath.TrimEnd('\\'))&quot; sn" ConsoleToMsBuild="true" StandardOutputImportance="low">
100107
<Output TaskParameter="ConsoleOutput" PropertyName="SNPath" />
101108
</Exec>
102109
<PropertyGroup>
103110
<SNPath>$([System.Text.RegularExpressions.Regex]::Replace('$(SNPath)', ';.*', ''))</SNPath>
104-
</PropertyGroup>
111+
</PropertyGroup>-->
105112
</Target>
106113

107114
<Import Project="..\..\props\common.props" />

‎src/OpenTK.Graphics/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OpenTK.Graphics
2+
3+
GLes11, GLes20, GLes30, GL2, and GL4 bindings for dotnet from the Khronos OpenGL c library.
4+
5+
Read more about how to use OpenTK at: https://opentk.net/

‎src/OpenTK.Graphics/paket‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,8 @@ files
1515
bin\Release\netstandard2.1\OpenTK.Graphics.pdb ==> lib\netstandard2.1
1616
bin\Release\netcoreapp3.1\OpenTK.Graphics.dll ==> lib\netcoreapp3.1
1717
bin\Release\netcoreapp3.1\OpenTK.Graphics.xml ==> lib\netcoreapp3.1
18-
bin\Release\netcoreapp3.1\OpenTK.Graphics.pdb ==> lib\netcoreapp3.1
18+
bin\Release\netcoreapp3.1\OpenTK.Graphics.pdb ==> lib\netcoreapp3.1
19+
README.md ==> docs\README.md
20+
21+
readme
22+
docs\README.md

0 commit comments

Comments
 (0)