Skip to content

Commit

Permalink
Add using this repository section
Browse files Browse the repository at this point in the history
Describe preferred approach to using the repository by first taking a fork and
then cloning that fork to ~/.clojure directory.

Add link to fork the repository.
  • Loading branch information
practicalli-johnny committed Apr 21, 2020
1 parent 36c01cd commit 1acf680
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# Practicalli deps.edn configuration
A feature rich `deps.edn` file with a collection of aliases for Clojure projects. Inspiration taken from [seancorfield/dot-clojure](https://github.com/seancorfield/dot-clojure).
A feature rich `deps.edn` file with a collection of aliases for Clojure projects. Include aliases with common options for convienience and to minimise the amount of cognitive load required to remember how to use aliases. Inspiration taken from [seancorfield/dot-clojure](https://github.com/seancorfield/dot-clojure).

Copy the `deps.edn` file to `~/.clojure/deps.edn` and the configuration and aliases will be included in any `deps.edn` project. Any directory can be a viable `deps.edn` project by including a `deps.edn` file containing an empty map, `{}` or a map with any additional configuration.

## Using this repository
[Fork this repository](https://github.com/practicalli/clojure-deps-edn/fork) and clone your fork to the `~/.clojure` directory in the root of your home directory for the operating system in use.

```shell
git clone your-fork-url ~/.clojure
```

Alternately, manually copy the `deps.edn` file or specific sections of that file to `~/.clojure/deps.edn`, creating that file if it does not exist.

The configuration and aliases will be included in any `deps.edn` project. Any directory containing a `deps.edn` project is considered a Clojure project. Project specific `deps.edn` files containing an empty map, `{}` or a map with any additional configuration. Either way, all the configuration from `~/.clojure/deps.edn` will be available (unless over-ridden by project specific settings).

## Updating
The collection of aliases is regularly reviewed and expanded upon and suggestions are most welcome.
Expand Down

0 comments on commit 1acf680

Please sign in to comment.