Skip to content

umcconnell/leaf-detective

Repository files navigation

leaf-detective

🚧 This is an experimental project!

A simple js AI library.

Table of Contents

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need node with npm installed on your machine to get started (visit https://nodejs.org to install node with npm).

Installing

A step by step series of examples that tell you how to get a development environment running:

Clone the git repository

git clone https://github.com/umcconnell/leaf-detective.git

And install npm dependencies

npm install

Running

To run any file, type:

node -r esm path/to/file.js

Examples

To run the provided examples, follow the installation steps outlined in the leaf-detective-examples repo to initialize the git submodule.

About

Docs

See https://umcconnell.github.io/leaf-detective for more information about program internals and examples.

Built With

  • jsdoc - The js documentation generator
  • minami - The documentation theme

Contributing

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

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Ulysse McConnell - umcconnell

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

See Also