Skip to content

CS386-Group-4/LumberjackNotes

Repository files navigation

LumberjackNotes

Version: 2.0.0

Lumberjack Notes is a note-taking application that improves both professionals’ and students’ note-taking ability by offering an easy, quick way of accessing the user interface. It also allows users to effectively share their notes with colleagues enhancing communication and collaboration remotely, which is significant in today’s time.

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

  • Git
  • Android Studio

Installing

  1. Clone the repository to your local machine.
  2. Open the project in Android Studio by navigating to the git repository on your local machine and select the "android_app" folder.
  3. Configure a device emulator in Android Studio or connect a device to Android Studio.
  4. Build the application with Gradle.
  5. Run the application using an emulated device or connected device.

Deployment

Since we are in alpha testing, we do not currently have a public deployment available.

Contributing

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

Versioning

Current Version: Version 2.0.0

Past Version(s): Version 1.0.0

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

Authors

License

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