Echo

Explore the dark with sound waves.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Development
   • Pull Request
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is the introduction of the game "Echo".

(back to top)

Built With

• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Unity (2021.3.9f1)

Installation

1. Clone the repo

   # Use SSH auth (Recommended for development)
   git clone git@github.com:redxouls/Echo.git
   
   # Default clone
   git clone https://github.com/redxouls/Echo.git

2. trigger git-lfs (Install git-lfs at https://git-lfs.github.com/)

   cd Echo
   git lfs install
   git lfs pull

(back to top)

Development

1. Create your Feature Branch

   # Make your local main up-to-date
   git checkout main
   git fetch origin
   git rebase origin/main
   
   # Create and checkout to a new branch with name feature/AmazingFeature
   git checkout -b feature/AmazingFeature

2. Commit your Changes

   git commit -m 'Add some AmazingFeature'
   

3. Sync your local branch with upstream/main

   git fetch origin
   git rebase origin/main

4. Push to the Branch

   git push origin feature/AmazingFeature

5. Open a Pull Request

(back to top)

Pull Request

Once the development is done, you can make a pull request with your branch.

Make a pull request

1. Click the Pull request tab.
2. Click the New pull request button.

3. At the compare branch dropdown, choose the branch you developed.
4. Review the file changes you made in the branch. After confirming the changes, click Create pull request.
5. Change the title of your pull request according to the issue you are dealing with. The tiltle should follow the format ECHO-#{ISSUE_NUMBER} {ISSUE_NAME}
6. Briefly describe what you've done and fill out the template for your pull request.

Merge Pull Request

1. Go to Files changed tab to review the changes.
2. If no conflict the merge button should be green.
3. Click on Squash and merge. and change the commit message to be as same as the title of this PR. The commit message should follow the format ECHO-#{ISSUE_NUMBER} {ISSUE_NAME}.
4. If the green merge button is not available, the conflict error is shown on the website. You should go back to your branch and fix the conflict first. You should git fetch and git rebase origin\main.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

Project Link: https://github.com/redxouls/Echo

(back to top)

Acknowledgments

(back to top)