Skip to content

Simple Android App for a Horn to be Played on Request of My Partner lol

Notifications You must be signed in to change notification settings

realgio95/heartHorn

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Best-README-Template

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

HEART HORN

Simple Android App for a Horn to be Played on Request of My Partner lol

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Next
  • React
  • Vue
  • Angular
  • Svelte
  • Laravel
  • Bootstrap
  • JQuery

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  2. Run app in android studio
  3. Grab a task and submit a pull request to make an improvement

(back to top)

Roadmap

  • design splash and Ui elements
  • [] Create v0
  • [] cusotmizations on the heart
  • [] Add hubs (multi ppl control of the hearts) and sign in functionality
  • Add Additional Templates w/ Examples
  • Add "options" to go to different parts of the app such as sign in and hearthorn huibs
  • Multi-language Support
    • Chinese
    • Spanish

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

Simple Android App for a Horn to be Played on Request of My Partner lol

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages