/cmr-exchange/dev-env-manager/README.md

https://github.com/nasa/Common-Metadata-Repository · Markdown · 67 lines · 41 code · 26 blank · 0 comment · 0 complexity · 23db1c718109e78c09910095adcfe8d7 MD5 · raw file 

    

  1. # cmr.dev.env.manager
    2. 

  2. 

  3. [![Build Status][travis-badge]][travis]
    4. 

  4. [![Clojars Project][clojars-badge]][clojars]
    5. 

  5. [![Tag][tag-badge]][tag]
    6. 

  6. [![Clojure version][clojure-v]](project.clj)
    7. 

  7. 

  8. [![][logo]][logo-large]
    9. 

  9. 

  10. *An Alternate Development Environment Manager for the CMR*
    11. 

  11. 

  12. 

  13. ## Setup
    14. 

  14. 

  15. To get up and running, see the documentation's [instructions for setup][setup].
    16. 

    17. 

  17. 

  18. ## Usage
    19. 

  19. 

  20. It's always nice to see some actual usage in the README, so here are some quick
    21. 

  21. teasers:
    22. 

  22. 

  23. ```clj
    24. 

  24. [cmr.dev.env.manager.repl] λ=> (startup)
    25. 

  25. ```
    26. 

  26. 

  27. For more details, be sure to see the [usage section][usage] of the docs!
    28. 

  28. 

  29. 

  30. ## Documentation
    31. 

  31. 

  32. [Guides and API docs are here][docs].
    33. 

  33. 

  34. 

  35. ## Architecture Overview
    36. 

  36. 

  37. [View docs][arch-overview].
    38. 

  38. 

  39. 

  40. ## Background
    41. 

  41. 

  42. For information on what problem this project attempts to define and how it was
    43. 

  43. originally planned, see the [background info][background-info].
    44. 

  44. 

  45. 

  46. ## License
    47. 

  47. 

  48. Apache License, Version 2.0.
    49. 

  49. 

  50. 

  51. <!-- Named page links below: /-->
    52. 

  52. 

  53. [travis]: https://travis-ci.org/cmr-exchange/dev-env-manager
    54. 

  54. [travis-badge]: https://travis-ci.org/cmr-exchange/dev-env-manager.png?branch=master
    55. 

  55. [logo]: resources/images/cmr-dev-env-mgr.png
    56. 

  56. [logo-large]: resources/images/cmr-dev-env-mgr-large.png
    57. 

  57. [tag-badge]: https://img.shields.io/github/tag/cmr-exchange/dev-env-manager.svg
    58. 

  58. [tag]: https://github.com/cmr-exchange/dev-env-manager/tags
    59. 

  59. [clojure-v]: https://img.shields.io/badge/clojure-1.8.0-blue.svg
    60. 

  60. [jdk-v]: https://img.shields.io/badge/jdk-1.7+-blue.svg
    61. 

  61. [clojars]: https://clojars.org/gov.nasa.earthdata/cmr-dev-env-manager
    62. 

  62. [clojars-badge]: https://img.shields.io/clojars/v/gov.nasa.earthdata/cmr-dev-env-manager.svg
    63. 

  63. [docs]: https://cmr-exchange.github.io/dev-env-manager/
    64. 

  64. [arch-overview]: https://cmr-exchange.github.io/dev-env-manager/current/1000-architecture.html
    65. 

  65. [background-info]: https://cmr-exchange.github.io/dev-env-manager/current/0000-background.html
    66. 

  66. [setup]: https://cmr-exchange.github.io/dev-env-manager/current/2000-setup.html
    67. 

  67. [usage]: https://cmr-exchange.github.io/dev-env-manager/current/3000-usage.html
    68.