EquipotentialX is an Android application developed with Kotlin, ARCore, and Ktor. It allows users to visualize the electric field and equipotential curves of two electric charges in Augmented Reality (AR). This application is a great tool for understanding and visualizing complex concepts in physics.
To run this application, you will need to have Android Studio installed on your machine. Here are the steps to install it:
- Download and install Android Studio from here.
- Clone this repository on your local machine using
git clone https://github.com/16george/EquipotentialX.git.
To run the application, follow these steps:
- Open Android Studio.
- Click on "File" -> "Open".
- Navigate to the directory of the cloned repository and click on "Open".
- Once the project is open, click on "Run" -> "Run 'app'".
Contributions are always welcome. To contribute:
- Fork the project.
- Create your Feature Branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the Branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
If you encounter any problems while setting up or running the application, please check the Issues section of this repository to see if your issue has already been addressed. If not, feel free to open a new issue with a description of the problem you're experiencing.
MIT License
Copyright (c) 2021 George Namoc
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.