Swifty-Protein

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

Swifty-Protein is an iOS application to visualize Ligands listed by the Protein Data Bank (PDB) with a Ball and Sticks model. Application allows users to zoom, rotate, and share visualizations. Utilizes TouchID to provide a secure authentication process.

Getting Started

No outside dependencies are required to build or run the application, outside of XCode.

Prerequisites

An up-to-date XCode installation is required to run the application simulation

Installation

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Application can be run inside XCode or loaded onto an iOS device.

Roadmap

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

Contributing

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

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

License

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

Contact

Travis Matthews - LinkedIn

Project Link: https://github.com/travmatth/SwiftyProtein

Acknowledgements

• Icon made by Freepik Freepik under the Creative Commons BY 3.0 License