-
Notifications
You must be signed in to change notification settings - Fork 597
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
[website] Write new Installation doc #3756
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! This was missing for a long time. Great initiative, Jack!
```sh | ||
sudo mv mill /usr/local/bin/ | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Advising uses to install something by moving things into a root-owned location is questionable. However, this is also what scala-cli suggests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AFAICT it's pretty universal that Linux-y things suggest you install things in /usr/local/bin
and if there's a reason you shouldn't it seems that the reader is expected to know this and adjust accordingly. I don't have a strong opinion, I'm just following typical style.
ac56405
to
3752693
Compare
3752693
to
fc7b3ea
Compare
There's a lot more I'd like to do, but I also want to avoid letting the perfect be the enemy of the good / scope creep and this vastly improves the getting started experience for the website.
This adds a new
Getting Started
section with anInstallation
page with a niceGetting Started
section using Scala CLIAs a teaser for how I want to make it even easier to get started, I have tweaked the chisel-template in a way that makes it super easy to start a new project, see https://github.com/jackkoenig/chisel-template.g8 which I intend to write a docs page for to put under
Installation
, something likeStarting a New Project
.Screenshots showing off how things look, note new
Getting Started
link front and center on homepage:Clicking that link takes you to the new
Installation
page with it'sQuickstart
:Contributor Checklist
docs/src
?Type of Improvement
Desired Merge Strategy
Release Notes
Revamps the website's instructions for "Getting Started".
Reviewer Checklist (only modified by reviewer)
3.5.x
,3.6.x
, or5.x
depending on impact, API modification or big change:6.0
)?Enable auto-merge (squash)
, clean up the commit message, and label withPlease Merge
.Create a merge commit
.