Skip to content

Commit e5f69a9

Browse files
docs: simplify docs, remove outdated content
1 parent a8952d8 commit e5f69a9

File tree

2 files changed

+18
-15
lines changed

2 files changed

+18
-15
lines changed

CHANGELOG.org

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
** Changed
55
*** DEPRECATED: `:lib/reloaded` & `:lib/tools-ns` - use `:dev/reloaded`
66
*** DEPRECATED: `:repl/rebel-cljs`, `:repl/figwheel`, `:repl/rebel-cljs` requires JVM with Nashorn, i.e. Java 8 - use figwheel-main template and [[https://practical.li/spacemacs/clojure-repl/clojurescript-repl/][Practicalli ClojureScript project workflow]]
7+
*** docs: update introduction and remove outdated content
78

89
* 2023-04-26
910
** Added

deps.edn

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,23 @@
1010
;; --------------------------------------------------
1111
;; Top-level keys for Clojure CLI deps.edn
1212

13-
;; :mvn/repositories - Maven & Clojars repositories, examples of other repositories
14-
;; :mvn/local-repo - example of setting a local repository path
15-
;; :aliases - tools to enhance a development workflow
16-
;; :paths - not included in this configuration
17-
;; :deps - not included in this configuration
13+
;; `:mvn/repositories` - Maven & Clojars repositories, examples of other repositories
14+
;; `:mvn/local-repo` - set local repository path - defaults to $HOME/.m2/repository
15+
;; `:aliases` - tools to enhance a development workflow
16+
;; `:paths` - directory paths to add to the class path
17+
;; `:deps` - library dependencies to add to the class path
18+
19+
;; `:paths` and `:deps` are typically used in the project `deps.edn`
20+
;; rather than a user `deps.edn` configuration
1821

1922
;; Keys used within :aliases
20-
;; resolve-deps aliases (-R) affect dependency resolution, options:
21-
;; :extra-deps - specifies extra deps to add to :deps
22-
;; :override-deps - specifies a coordinate to use instead of that in :deps
23-
;; :default-deps - specifies a coordinate to use for a lib if one isn't found
24-
;; make-classpath aliases (-C) affect the classpath generation, options:
25-
;; :extra-paths - vector of additional paths to add to the classpath
26-
;; :classpath-overrides - map of lib to path that overrides the result of resolving deps
23+
;; resolve-deps aliases affect dependency resolution, options:
24+
;; `:extra-deps` - specifies extra deps to add to :deps
25+
;; `:override-deps` - specifies a coordinate to use instead of that in :deps
26+
;; `:default-deps` - specifies a coordinate to use for a lib if one isn't found
27+
;; make-classpath aliases affect the classpath generation, options:
28+
;; `:extra-paths` - vector of additional paths to add to the classpath
29+
;; `:classpath-overrides` - map of lib to path that overrides the result of resolving deps
2730
;; ---------------------------------------------------
2831

2932

@@ -32,7 +35,7 @@
3235

3336
;; Specify a local repository for maven - default `$HOME/.m2/repository`
3437
;; FreeDesktop.org XDG_CACHE_HOME is the recommended location
35-
;; Full path should be used, otherwise directory relative command is used
38+
;; Full path should be used, otherwise a relative directory path will be created
3639
;; :mvn/local-repo "/home/practicalli/.cache/maven/repository"
3740

3841
;; `clojure -Spath` will show the current class path which will include the path to the local maven repository for the library dependencies.
@@ -876,7 +879,6 @@
876879
:sha "b1a7fd310b6511048fbacb8e496f574c8ccfa291"}}
877880
:main-opts ["-m" "closh.zero.frontend.rebel"]}
878881

879-
#_()}
880-
;; End of alias definitions
882+
#_()} ; End of alias definitions
881883
;; --------------------------------------------------
882884
}

0 commit comments

Comments
 (0)