Skip to content

Commit

Permalink
Update guides and CLI UI after rename from Elm-Time
Browse files Browse the repository at this point in the history
  • Loading branch information
Viir committed Apr 14, 2024
1 parent bf422f7 commit ec9bf5d
Show file tree
Hide file tree
Showing 29 changed files with 46 additions and 46 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build-and-publish-elm-silent-teacher.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: download elm-time
- name: download build tool
run: |
pwsh -nologo -noprofile -command "Invoke-WebRequest 'https://github.com/pine-vm/pine/releases/download/v2023-09-12/elm-time-bin-v2023-09-12-linux-x64.zip' -OutFile elm-time-linux-x64.zip"
pwsh -nologo -noprofile -command "& { Add-Type -A 'System.IO.Compression.FileSystem'; [IO.Compression.ZipFile]::ExtractToDirectory('elm-time-linux-x64.zip','./elm-time');}"
- name: install elm-time
- name: install build tool
run: |
chmod +x ./elm-time/elm-time
sudo ./elm-time/elm-time install
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish-to-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ jobs:
shell: pwsh
run: |
New-Item -ItemType Directory -Force -Path "./publish";
Get-ChildItem -Path "./dotnet-build/" -Filter "elm-time*" | ForEach-Object { Copy-Item -Path $_.FullName -Destination "./publish/" }
Get-ChildItem -Path "./dotnet-build/" -Filter "pine-cli*" | ForEach-Object { Copy-Item -Path $_.FullName -Destination "./publish/" }
- name: Publish artifacts
uses: actions/upload-artifact@v4
with:
name: elm-time-bin-${{ steps.tagName.outputs.tag }}-${{ matrix.publish-runtime-id }}
name: pine-bin-${{ steps.tagName.outputs.tag }}-${{ matrix.publish-runtime-id }}
path: ./publish

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ The integrated Elm compiler offers various interfaces supporting the automatic g

Download the pre-built Pine binary for your platform at <https://pinevm.org/download>, or on the [releases page](https://github.com/pine-vm/pine/releases) on GitHub.

The `elm-time` executable file integrates all functionality to build apps and operate web services.
The `pine` executable file integrates all functionality to build apps and operate web services.

The command below runs a server and deploys a full-stack web app:

```txt
elm-time run-server --public-urls="http://*:5000" --deploy=https://github.com/pine-vm/pine/tree/8dbd5c91853fbcef3b645d95bccc01a886ccd7e2/implement/example-apps/docker-image-default-app
pine run-server --public-urls="http://*:5000" --deploy=https://github.com/pine-vm/pine/tree/8dbd5c91853fbcef3b645d95bccc01a886ccd7e2/implement/example-apps/docker-image-default-app
```


Expand Down
2 changes: 1 addition & 1 deletion guide/how-to-configure-and-deploy-an-elm-backend-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The backend includes a web server and a database persisting the application stat

## Installing and Registering the `elm-time` Command

In this guide, I use the `elm-time` command-line interface (CLI) program. You can find all downloads at <https://elm-time.org/downloads> and <https://github.com/pine-vm/pine/releases>
In this guide, I use the `elm-time` command-line interface (CLI) program. You can find all downloads at <https://pinevm.org/downloads> and <https://github.com/pine-vm/pine/releases>

To register the elm-time executable on your system, run the `elm-time install` command. If you use Linux or PowerShell on Windows, you can achieve this by running the following command after navigating to the directory containing the executable file extracted from the downloaded archive:

Expand Down
8 changes: 4 additions & 4 deletions implement/Pine/Pine.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
<AssemblyVersion>0.1.7</AssemblyVersion>
<FileVersion>0.1.7</FileVersion>
<AssemblyVersion>0.1.8</AssemblyVersion>
<FileVersion>0.1.8</FileVersion>
</PropertyGroup>

<PropertyGroup>
<PackageId>Pine</PackageId>
<Version>0.1.7</Version>
<Version>0.1.8</Version>
<Description>The cross-platform Elm runtime environment</Description>
<PackageTags>Functional;Elm;Runtime;Compiler;VM;DBMS</PackageTags>
<RepositoryUrl>https://github.com/pine-vm/pine.git</RepositoryUrl>
<PackageProjectUrl>https://elm-time.org</PackageProjectUrl>
<PackageProjectUrl>https://pinevm.org</PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<Authors>Viir</Authors>
<PackageLicenseFile>License.txt</PackageLicenseFile>
Expand Down
2 changes: 1 addition & 1 deletion implement/Pine/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Pine is the cross-platform Elm runtime environment.

+ Website: <https://elm-time.org>
+ Website: <https://pinevm.org>
+ Source code repository: <https://github.com/pine-vm/pine>
2 changes: 1 addition & 1 deletion implement/elm-time/Gui/elm/src/Frontend/Main.elm
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ viewAdminInterfaceConfig state config =
]
, [ Element.text ("This instance currently runs version " ++ config.elmTimeVersionId ++ ".") ]
, [ Element.text "To check for newer versions, see "
, Visuals.linkElementFromHref { newTabLink = False } "https://elm-time.org/download"
, Visuals.linkElementFromHref { newTabLink = False } "https://pinevm.org/download"
, Element.text " or "
, Visuals.linkElementFromHref { newTabLink = False } "https://github.com/pine-vm/pine/releases"
]
Expand Down
16 changes: 8 additions & 8 deletions implement/elm-time/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ namespace ElmTime;

public class Program
{
public static string AppVersionId => "0.1.7";
public static string AppVersionId => "0.1.8";

private static int AdminInterfaceDefaultPort => 4000;

Expand All @@ -41,13 +41,13 @@ private static int MainLessDispose(

var app = new CommandLineApplication
{
Name = "elm-time",
Description = "Elm-Time - runtime environment for Elm.\nTo get help or report an issue, see https://github.com/pine-vm/pine/discussions",
Name = "pine",
Description = "Pine - runtime environment for Elm.\nTo get help or report an issue, see https://github.com/pine-vm/pine/discussions",
HelpTextGenerator =
new McMaster.Extensions.CommandLineUtils.HelpText.DefaultHelpTextGenerator { SortCommandsByName = false }
};

app.VersionOption(template: "-v|--version", shortFormVersion: "elm-time " + AppVersionId);
app.VersionOption(template: "-v|--version", shortFormVersion: "pine " + AppVersionId);

var installCommand = app.Command("install", installCommand =>
{
Expand Down Expand Up @@ -217,7 +217,7 @@ private static int MainLessDispose(
"\n\n",
app.Description,
"Usage: " + elmFsCommandName + " [command] [options]",
"These are common elm-time commands used in various situations:",
"These are common pine commands used in various situations:",
string.Join("\n\n", groupsTexts),
"'" + elmFsCommandName + " help -a' lists available subcommands.\nSee '" + elmFsCommandName + " help <command>' to read about a specific subcommand.");
Expand Down Expand Up @@ -1878,7 +1878,7 @@ private static (CommandOption elmCompilerOption, Func<Pine.IConsole, TreeNodeWit
var elmCompilerOption =
cmd.Option(
template: "--elm-compiler",
description: "Select a program for compiling Elm programs. Defaults to the version integrated with Elm-Time.",
description: "Select a program for compiling Elm programs. Defaults to the version integrated with Pine.",
optionType: CommandOptionType.SingleValue,
inherited: true);

Expand Down Expand Up @@ -2740,7 +2740,7 @@ private static (string commandName, Func<(bool executableIsRegisteredOnPath, Act
return (commandName, checkInstallation);
}

private static string ReportFilePath => Path.Combine(Environment.CurrentDirectory, "elm-time-tool", "report");
private static string ReportFilePath => Path.Combine(Environment.CurrentDirectory, "pine-tool", "report");

static readonly System.Text.Json.JsonSerializerOptions reportJsonSerializerOptions = new()
{
Expand Down Expand Up @@ -2768,7 +2768,7 @@ private static System.Net.Http.HttpRequestMessage AddUserAgentHeader(
{
httpRequest.Headers.UserAgent.Add(
new System.Net.Http.Headers.ProductInfoHeaderValue(
new System.Net.Http.Headers.ProductHeaderValue("elm-time-cli", AppVersionId)));
new System.Net.Http.Headers.ProductHeaderValue("pine-cli", AppVersionId)));

return httpRequest;
}
Expand Down
4 changes: 2 additions & 2 deletions implement/elm-time/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Elm-Time is an open-source, cross-platform runtime environment for the Elm programming language.
Pine is the cross-platform Elm runtime environment.

+ Website: https://elm-time.org
+ Website: https://pinevm.org
+ Source code repository: https://github.com/pine-vm/pine
8 changes: 4 additions & 4 deletions implement/elm-time/elm-time.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<RootNamespace>ElmTime</RootNamespace>
<AssemblyName>elm-time</AssemblyName>
<AssemblyVersion>0.1.7</AssemblyVersion>
<FileVersion>0.1.7</FileVersion>
<AssemblyName>pine-cli</AssemblyName>
<AssemblyVersion>0.1.8</AssemblyVersion>
<FileVersion>0.1.8</FileVersion>
<Nullable>enable</Nullable>
<GenerateEmbeddedFilesManifest>true</GenerateEmbeddedFilesManifest>
</PropertyGroup>
Expand All @@ -15,7 +15,7 @@
<Description>Runtime environment for the Elm programming language</Description>
<PackageTags>Elm;Runtime;DBMS</PackageTags>
<RepositoryUrl>https://github.com/pine-vm/pine.git</RepositoryUrl>
<PackageProjectUrl>https://elm-time.org</PackageProjectUrl>
<PackageProjectUrl>https://pinevm.org</PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<Authors>Viir</Authors>
<PackageLicenseFile>License.txt</PackageLicenseFile>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down
2 changes: 1 addition & 1 deletion implement/website/pinevm/src/Platform/WebService.elm
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Platform.WebService exposing (..)
{-| This module contains the types describing the Pine / Elm web service platform.
To build a web service app in Elm, copy this module file into your project and add a declaration with the name `webServiceMain` to an Elm module.
For the latest version of the documentation, see <https://elm-time.org>
For the latest version of the documentation, see <https://pinevm.org>
-}

Expand Down

0 comments on commit ec9bf5d

Please sign in to comment.