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

Please add a basic Quick start guide for installing tool and creating first project #20

Open
kristianmandrup opened this issue Mar 3, 2019 · 4 comments

Comments

@kristianmandrup
Copy link

kristianmandrup commented Mar 3, 2019

What is the best way to get started using dotnet saturn

Please provide some basic quick start documentation in the Readme or a link to wiki, blog post or similar.

[I] ⋊> ~/r/f/SAFE-projects dotnet saturn
No executable found matching command "dotnet-saturn"

What do I need to do in order to have the saturn CLI available on my Mac OSX?

Note: I've been looking at the SAFE stack documentation site, but still not clear. Cheers.

Is it a dotnet CLI tool I assume? If so, how do I extend the core set of tools with saturn?

Ah, I think this is it: how-to-start please add link to this resource :)

[I] ⋊> dotnet new -i Saturn.Template                                                       16:41:11
  Restoring packages for /Users/kristianmandrup/.templateengine/dotnetcli/v2.2.103/scratch/restore.csproj...
  Installing Saturn.Template 0.7.0.
[I] ⋊>  mkdir SaturnSample
[I] ⋊>  cd SaturnSample
[I] ⋊>  dotnet new saturn -lang F#
The template "Saturn v0.7.0" was created successfully.
@kristianmandrup kristianmandrup changed the title Please add a Getting Started guide or link Please add a basic Quick start guide for installing tool and creating first project Mar 3, 2019
@kristianmandrup
Copy link
Author

Also please add a note, that for fish shell (or other non-bash shells), one needs to run build via:

$ bash build.sh

@winsider
Copy link

winsider commented Mar 6, 2019

I have an existing project created with the SAFE project template, but the Saturn CLI is missing. How can I add it to this existing project?

@MarneeDear
Copy link

I was able to add it manually using packet.

Top level/solution level paket.dependencies

framework: auto-detect

source https://api.nuget.org/v3/index.json

clitool dotnet-saturn

Your Saturn project-level paket.refences

dotnet-saturn

Run paket install on the top level/solution level.

Then go to your Saturn project and run:

dotnet saturn

The command should be recognized.

I hope this helps.

@kristianmandrup
Copy link
Author

Great! Thanks! I will try to make a PR with this guide included in the top level Readme

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants