-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update paths * Rename docs
- Loading branch information
Showing
57 changed files
with
101 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/architecture/Build-Extension.md → docs/architecture/build-extension.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Build Extension | ||
|
||
A [Wren](https://wren.io/) package that contains one or more implementations of the [Build Task](Build-Task.md) interface. When referenced as a **Build** Dependency within a [Recipe](Recipe.md) the Generate runtime will automatically discover and instantiate one instance of each public class that implements the shared interface definition. The | ||
A [Wren](https://wren.io/) package that contains one or more implementations of the [Build Task](build-task.md) interface. When referenced as a **Build** Dependency within a [Recipe](recipe.md) the Generate runtime will automatically discover and instantiate one instance of each public class that implements the shared interface definition. The |
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/architecture/Local-User-Config.md → docs/architecture/local-user-config.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Command Line Interface (CLI) | ||
Soup is at its core a command line application. The CLI is designed to be as clean and simple as possible while still allowing for easy execution of common build related tasks. | ||
|
||
``` | ||
soup <command> [arguments] | ||
``` | ||
|
||
* [Build](cli/build.md) - Perform a build with a specified root Package. | ||
|
||
* [Init](cli/init.md) - Initialize a new Package with default properties. | ||
|
||
* [Install](cli/install.md) - Install a new dependency for a specified Package. | ||
|
||
* [Publish](cli/publish.md) - Publish a given package to the public feed. | ||
|
||
* [Restore](cli/restore.md) - Restore all external package references in the target project closure. | ||
|
||
* [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. | ||
|
||
* [View](cli/view.md) - Launch the Soup View tool. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,14 @@ | ||
# View | ||
## Overview | ||
Launch the Soup View untility GUI for visualizing the build dependency, tasks and operation graphs. | ||
Launch the Soup View utility GUI for visualizing the build dependency, tasks and operation graphs. | ||
``` | ||
soup view <path> | ||
``` | ||
|
||
`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. | ||
|
||
## Examples | ||
Luanch the tool in the current directory for debug with default configurations. | ||
Launch the tool in the current directory for debug with default configurations. | ||
``` | ||
soup view | ||
``` |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
Oops, something went wrong.