README.org 1.9 KB
Newer Older
1 2 3 4
* lib-ical

[[https://www.gnu.org/graphics/agplv3-155x51.png]]

Mark Stenglein's avatar
Mark Stenglein committed
5 6
[[https://git.gmu.edu/srct/lib-ical/badges/develop/coverage.svg]]

7 8 9 10 11 12 13
lib-ical is an npm library which implements the ical standard defined in RFC
5545.

** Getting Started

*** Prerequisites

14
    For this repository, you will need nodejs and npm installed. We currently target the latest version of Node.
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

*** Installing

    Simply install with npm, and optionally save it to your dependencies:

** Running the tests

   To run the test suite, simply clone the repository and run ~npm test~.

** Coding style

   The linting rules defined in [[.tslint]] should be folled. The test suite does
   (will) enforce this for all pull requests.

** Contributing

31 32 33 34 35 36 37 38 39 40 41 42
   Please read [[CONTRIBUTING.org]] for detailed information on how to get started
   working on this project. This file goes over the project standards and requirements
   of any submissions.

*** Finding something to contribute with

   I would highly reccomend searching the tree for any `TODO` items if you are looking
   for some direction on something to do. Assuming you are in the root of the repo,
   the command `grep "TODO" -r ./src` should do a good job of showing you where any
   unfinished thoughts are.

   From there, simply work on the fix and submit the merge request or patch when done!
43 44 45 46 47 48

   for details on our code of conduct, and the process for submitting pull
   requests to us.

** Versioning

49 50
   We use [[http://semver.org/][SemVer]] for versioning. For the versions available,
   see the [[https://github.com/ocelotsloth/lib-ical/tags][tags on this repository]].
51 52 53 54 55 56 57 58 59 60 61 62 63

** Authors

   - **Mark Stenglein** - *Initial work* - [[https://github.com/ocelotsloth][ocelotsloth]]

   See also the list of [[https://git.gmu.edu/srct/lib-ical/contributors][contributors]]
   who participated in this project.

** License

   This project is licensed under the AGPLv3 License - see the [[LICENSE]]
   file for details