Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #144

Merged
merged 3 commits into from
Sep 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Docs/Architecture/Recipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ The **Dependencies** property is a table of different dependency types that each
```
Dependencies: {
Runtime: [
"../MyOtherPackage/",
"CoolPublicPackage@1.0.1",
{ Reference: "AnotherCoolPublicPackage@2.0.1" },
"../MyOtherPackage/"
"CoolPublicPackage@1.0.1"
{ Reference: "AnotherCoolPublicPackage@2.0.1" }
]
}
```
Expand Down
2 changes: 2 additions & 0 deletions Docs/CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,6 @@ soup <command> [arguments]

* [Run](CLI/Run.md) - Invoke the executable result (if applicable) for a specified package.

* [Target](CLI/Target.md) - Prints the target directory for a specified package.

* [Version](CLI/Version.md) - Print the version of the current installed Soup application.
2 changes: 1 addition & 1 deletion Docs/CLI/Install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Install
## Overview
Install packages from the public feed.
Install a package from the public feed.
```
soup install <path> name<@version>
```
Expand Down
2 changes: 1 addition & 1 deletion Docs/CLI/Target.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Overview
Print the unique target directory for a recipe that would be built using the provided configuration parameters.
```
soup run <path> [-flavor <name>] [-args <arg1> <arg2> etc.]
soup target <path> [-flavor <name>] [-args <arg1> <arg2> etc.]
```

`path` - An optional parameter that directly follows the build command. If present this specifies the directory to look for a Recipe file to build. If not present then the command will use the current active directory.
Expand Down
8 changes: 4 additions & 4 deletions Docs/Samples/CSharp/Build-Extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Source: [

Dependencies: {
Runtime: [
{ Reference = "Soup.Build@0.2.0", ExcludeRuntime = true },
{ Reference = "Soup.Build.Extensions@0.4.0" },
{ Reference = "Opal@1.1.0" },
{ Reference = "Soup.Build@0.2.0", ExcludeRuntime = true }
{ Reference = "Soup.Build.Extensions@0.4.0" }
{ Reference = "Opal@1.1.0" }
]
}
```
Expand Down Expand Up @@ -85,7 +85,7 @@ The Recipe file that defines the executable "BuildExtension.Executable". The one
Name: "Samples.CSharp.BuildExtension.Executable"
Language: "C#|0.1"
Type: "Executable"
Version: "1.0.1"
Version: "1.0.0"
Source: [
"Program.cs"
]
Expand Down
6 changes: 6 additions & 0 deletions Docs/Samples/Cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ This is a console application that uses a custom build extension to set a prepro
## [Console Application](Cpp/Console-Application.md)
This is the smallest amount of code to get a console application building using Soup.

## [DirectX](Cpp/DirectX.md)
This is a console application that demonstrates a more complex graphics application.

## [Dynamic Library](Cpp/Dynamic-Library.md)
This is a console application that has a single dynamic library dependency.

Expand All @@ -18,3 +21,6 @@ This is a console application that reads in a json file using the an external mo

## [Static Library](Cpp/Static-Library.md)
This is a console application that has a single static library dependency.

## [Windows Application](Cpp/Windows-Application.md)
This is a windows win32 application that demonstrates how to create a windows GUI application.
41 changes: 36 additions & 5 deletions Docs/Samples/Cpp/Build-Extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,15 @@ The Recipe file that defines the executable "Samples.Cpp.BuildExtension.Executab
Name: "Samples.SimpleBuildExtension.Executable"
Language: "C++|0.1"
Type: "Executable"
Version: "1.0.1"
Version: "1.0.0"
Source: [
"Main.cpp"
"Main.cpp"
]

Dependencies: {
Build: [
"../Extension/"
]
Build: [
"../Extension/"
]
}
```

Expand All @@ -115,6 +115,37 @@ int main()

```

## Executable/PackageLock.sml
The package lock that was generated to capture the unique build dependencies required to build this project.
```
Version: 2
Closures: {
Root: {
C#: [
{ Name: "Opal", Version: "1.1.0", Build: "Build1" }
{ Name: "Samples.Cpp.BuildExtension.Extension", Version: "../Extension/", Build: "Build1" }
{ Name: "Soup.Build", Version: "0.2.0", Build: "Build1" }
{ Name: "Soup.Build.Extensions", Version: "0.4.0", Build: "Build1" }
]
C++: [
{ Name: "Samples.SimpleBuildExtension.Executable", Version: "../Executable", Build: "Build0" }
]
}
Build0: {
C#: [
{ Name: "C++", Version: "0.1.0" }
{ Name: "Samples.Cpp.BuildExtension.Extension", Version: "../Extension/" }
]
}
Build1: {
C#: [
{ Name: "C#", Version: "0.1.0" }
]
}
}

```

## .gitignore
A simple git ignore file to exclude all Soup build output.
```
Expand Down
8 changes: 4 additions & 4 deletions Docs/Samples/Cpp/Console-Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ This is the smallest amount of code to get a console application building using
The Recipe file that sets the name, type, version and the single source file.
```
Name: "Samples.Cpp.ConsoleApplication"
Language = "C++|0.1"
Type = "Executable"
Version = "1.1.3"
Source = [
Language: "C++|0.1"
Type: "Executable"
Version: "1.0.0"
Source: [
"Main.cpp"
]
```
Expand Down
34 changes: 34 additions & 0 deletions Docs/Samples/Cpp/DirectX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# C++ DirectX
This is a console application that demonstrates creating a complex graphics windows application.

[Source](https://github.com/SoupBuild/Soup/tree/main/Samples/Cpp/DirectX)

## Library/Recipe.sml
The Recipe file that defines the directX sample application. Note the special module partition hierarchy that explicitly sets the references for partition units. The application also copies over the shader files that will be compiled at runtime.
```
Name: "Samples.Cpp.DirectX"
Language: "C++|0.1"
Type: "Windows"
Version: "1.0.0"
Partitions: [
{ Source: "D3D12HelloTriangle.cpp", Imports: [ "DXSample.cpp", "DXSampleHelper.cpp", "Win32Application.cpp" ] }
{ Source: "DXSample.cpp", Imports: [ "DXSampleHelper.cpp" ] }
{ Source: "DXSampleHelper.cpp" }
{ Source: "Win32Application.cpp", Imports: [ "DXSample.cpp", "DXSampleHelper.cpp" ] }
]
Interface: "Interface.cpp"
Source: [
"Main.cpp"
]
PlatformLibraries: [
"D3D12.lib"
"D3DCompiler.lib"
"DXGI.lib"
]
RuntimeDependencies: [
"Shaders.hlsl"
]
```

## Content
The remaining content assumes that you are familiar with creating a graphics application and windows. This is not meant as a graphics tutorial and is only present as a sample of a more complex scenario for building within Soup.
2 changes: 1 addition & 1 deletion Docs/Samples/Cpp/Module-Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Recipe file that sets the name, type, version, the public interface module a
Name: "Samples.Cpp.ModuleInterface"
Language: "C++|0.1"
Type: "Executable"
Version: "1.2.5"
Version: "1.0.0"
Interface: "Module.cpp"
Source: [
"Main.cpp"
Expand Down
4 changes: 2 additions & 2 deletions Docs/Samples/Cpp/Parse-Json-File.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Language: "C++|0.1"
Version: "1.0.0"
Type: "Executable"
Source: [
"Main.cpp",
"Main.cpp"
]

Dependencies: {
Runtime: [
"json11@1.0.2",
"json11@1.0.2"
]
}
```
Expand Down
20 changes: 20 additions & 0 deletions Docs/Samples/Cpp/windows-application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# C++ Windows Application
This is a windows application that demonstrates creating a GUI windows application.

[Source](https://github.com/SoupBuild/Soup/tree/main/Samples/Cpp/WindowsApplication)

## Library/Recipe.sml
The Recipe file that defines the sample application.
```
Name: "Samples.Cpp.WindowsApplication"
Language: "C++|0.1"
Type: "Windows"
Version: "1.0.0"
Resources: "WindowsProject.rc"
Source: [
"WindowsProject.cpp"
]
```

## Content
The remaining content assumes that you are familiar with creating a windows applications. This is not meant as a windows tutorial and is only present as a sample of a more complex scenario for building within Soup.