Add documentation

This commit is contained in:
Andros Fenollosa 2019-08-04 11:22:57 +02:00
parent 770b6ed18f
commit 84831ea7bf
4 changed files with 28 additions and 17 deletions

View File

@ -12,20 +12,28 @@ cp config-example.edn config.edn
java -jar isahn-[version]-standalone.jar
```
## Check format
## Development
### Check format
``` sh
lein cljfmt check
```
## Check format
### Linter
``` sh
lein cljfmt check
clj-kondo --lint src
```
## Linter
### Check idiomatic
``` sh
lein auto kibit
```
### Generate doc
``` sh
lein codox
```

1
doc Symbolic link
View File

@ -0,0 +1 @@
target/default/doc

View File

@ -1,3 +0,0 @@
# Introduction to isahn
TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)

View File

@ -1,23 +1,28 @@
(defproject isahn "0.1.0-SNAPSHOT"
(defproject isahn "1.0.0"
:description "ISAHN check news stories for Hacker News"
:url "http://example.com/FIXME"
:micense {:name "EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0"
:url "https://www.eclipse.org/legal/epl-2.0/"}
:url "https://github.com/tanrax/important-stories-alert-for-hacker-news"}
:dependencies [
; Clojure
;; Clojure
[org.clojure/clojure "1.10.0"]
; Get config from .env
;; Get config from .env
[yogthos/config "1.1.4"]
; Client HTTP
;; Client HTTP
[clj-http "3.10.0"]
; Parse JSON
;; Parse JSON
[cheshire "5.8.1"]
]
]
:plugins [
; Dev Tools
;; Dev Tools
;;; Watch changes
[lein-auto "0.1.3"]
;;; Check idiomatic bug
[lein-kibit "0.1.7"]
;;; Check format
[lein-cljfmt "0.6.4"]
;;; Generate documentation
[lein-codox "0.10.7"]
]
:main ^:skip-aot isahn.core
:target-path "target/%s"