Flesh out the Getting Started instructions in the README #564
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is my impression that Reagent is the flagship project for implementing dynamic frontends in the Clojure world. So I was a little disappointed how long it took me to start using the project. I came to the project knowing nothing about the Clojure frontend world, but having some experience with both Clojure and Leinengen, and extensive experience with the JavaScript/React/npm ecosystem. And yet I was really stumped how to use the darn thing.
lein rundidn't really work.npm startdefinitely didn't. So then I had to do a deep dive into what figwheel is and what shadow-cljs is and when you would use each. "Before you can run this project you must first understand the entire ecosystem it lives in"—probably not what this project is going for. Anyway, I'm rambling...Thankfully, I think it's easy to fill in the key details that an impatient, ignorant user like myself needs. I've taken a stab at it here. Not sure if this is actually the best/recommended way to run the project currently—please advise. I tried to be consistent with: #551
One other thought: the project has a beautiful website. The complete Getting Started information should live there IMO (it's the first place I checked), with perhaps an abbreviated version in the README and/or a prominent link to the Getting Started section there. But as a first step I stuck with the existing pattern of putting this information in the README.