diff --git a/README.md b/README.md index 2cad80b1..09affde9 100644 --- a/README.md +++ b/README.md @@ -138,30 +138,6 @@ Roadmap is mostly written in [issues](https://github.com/metosin/reitit/issues). * [Compojure-api](https://github.com/metosin/compojure-api), [Kekkonen](https://github.com/metosin/kekkonen), [Ring-swagger](https://github.com/metosin/ring-swagger) and [Yada](https://github.com/juxt/yada) and for ideas, coercion & stuff. * [Schema](https://github.com/plumatic/schema) and [clojure.spec](https://clojure.org/about/spec) for the validation part. -## Development instructions - -The documentation is built with [gitbook](https://toolchain.gitbook.com). To preview your changes locally: - -```bash -npm install -g gitbook-cli -gitbook install -gitbook serve -``` - -To bump up version: - -```bash -# new version -./scripts/set-version "1.0.0" -./scripts/lein-modules install - -# works -lein test - -# deploy to clojars -./scripts/lein-modules do clean, deploy clojars -``` - ## License Copyright © 2017-2018 [Metosin Oy](http://www.metosin.fi) diff --git a/doc/SUMMARY.md b/doc/SUMMARY.md index 41312dbb..7d168cce 100644 --- a/doc/SUMMARY.md +++ b/doc/SUMMARY.md @@ -31,4 +31,5 @@ * [Swagger Support](ring/swagger.md) * [Performance](performance.md) * [Interceptors (WIP)](interceptors.md) +* [Development Instructions](development.md) * [FAQ](faq.md) diff --git a/doc/development.md b/doc/development.md new file mode 100644 index 00000000..d40b4253 --- /dev/null +++ b/doc/development.md @@ -0,0 +1,38 @@ +# Development Instructions + +## Building + +```bash +./scripts/lein-modules do clean, install +``` + +## Running tests + +```bash +./scripts/test.sh clj +./scripts/test.sh cljs +``` + +## Documentation + +The documentation is built with [gitbook](https://toolchain.gitbook.com). To preview your changes locally: + +```bash +npm install -g gitbook-cli +gitbook install +gitbook serve +``` + +## To bump up version: + +```bash +# new version +./scripts/set-version "1.0.0" +./scripts/lein-modules install + +# works +lein test + +# deploy to clojars +./scripts/lein-modules do clean, deploy clojars +```