swiftly icon indicating copy to clipboard operation
swiftly copied to clipboard

Add development help

Open MahdiBM opened this issue 2 years ago • 1 comments

There are no explanations on how to help developing Swiftly.

I personally had to:

  1. Use SSWG's VSCode extension and set up a dev container to develop Swiftly on macOS, because otherwise there are some macOS-related errors, and also Swiftly doesn't yet support macOS.
  2. Create a file at /root/.local/share/swiftly/config.json containing the json below, because otherwise swiftly would complain about the file and wouldn't work:
{
  "platform" : {
    "nameFull" : "ubuntu22.04",
    "name" : "ubuntu2204",
    "namePretty" : "Ubuntu 22.04.1 LTS"
  },
  "inUse" : null,
  "installedToolchains" : []
}
  1. Use swift run swiftly [subcommand].

MahdiBM avatar Apr 03 '23 14:04 MahdiBM

@MahdiBM we don't really have a contributors guide at the moment. But, we do have a subcommand of swiftly devoted to configuring and installing itself that should work in dev too.

swift run swiftly init

And then you could try things like:

swift run swiftly install main-snapshot

But then, if you are already using swiftly it will tend to overwrite it and in each of these examples it might use a different version of swift.

cmcgee1024 avatar Nov 25 '24 16:11 cmcgee1024