README install options are too complicated

Open Beginner friendly
#41 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
clojure
Domain
documentation

Research direction

Start in the README and review its current installation instructions, then identify how the Leiningen 2 and zipfile-based paths are presented. Restructure the installation guidance so those two blessed options are clearly called out as separate paths, and confirm both are easy to follow without searching through other sections.

Written by the indexing model from the issue text.

Description

There should be exactly two blessed ways to run the koans. Using lein 2 is a good idea to get people a good REPL and have them ready to actually do things when they're done w/ the koans. But there's also a lot of value in the easy zipfile-based approach where you just download, unzip, and go.

Calling those 2 paths out specifically would probably help, so people can follow one thread rather than searching for their option in every section.

Dominant language
Clojure
Stars
3.8k
Forks
2.1k
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from functional-koans/clojure-koans

All issues in functional-koans/clojure-koans

Similar issues

More Clojure issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.