Skip to content

Commit 0e792b2

Browse files
committed
docs: adds information about config files
1 parent cd52d6c commit 0e792b2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ DB->>CI: Bulk-transact all datoms
3232
CI->>RE: Zip and Publish
3333
```
3434

35+
# Config `resources/config.edn`
36+
This file has two main functions:
37+
- `:db` key is defined where the datalevin files will be placed.
38+
- `:deps` key is defined which libraries will be downloaded, parsed and indexed in the database
39+
- This configuration is made using the same [clojure.tools.deps's git coordinates](https://clojure.org/reference/deps_edn#deps_git) with some extra keys:
40+
- `:project/group` use to overide the project group, currently extracted from the lib ORG
41+
- `:deps/manifest :deps` since we use tools.deps we need to set this on pure lein projects to force the download of the lib.
42+
- `:project/source-paths` if a lein lib uses `:source-paths`, like reitit, we need to add this information here to indicate to clj-kondo where are the files to analyze.
43+
3544
# Using
3645
Go to this github [release page](https://github.com/clj-codes/docs.extractor/releases), download and unzip the `docs-db.zip` file.
3746

0 commit comments

Comments
 (0)