Short template for python projects
{description}
Note: The {project name} only supports the Windows platform at the moment.
- Kivy: a Python framework for developing user interface applications
To get a local copy up and running follow these simple steps.
In order to use the {name}, you must first have Python and pip installed on your system. If you need assistance installing these prerequisites, see the folowing steps:
-
Python is a programming language. All of this project's code base is written in Python. Download the latest version of Python and install onto your local machine.
-
Pip is the package installer for Python. Once Python is installed, open your local machine's command line and use the following command to utilize Python to install Pip:
python get-pip.py -gGit is a version control system. In this project, Git is used to clone (copy) the most up-to-date project files from GitHub to your local machine. Download the latest version of git and install on your local machine.
-
Open the command line on your local machine.
-
Enter the following command to use Git to clone this repository to your local machine.
git clone https://github.com/asa-leholland/backstory-shuffleduffler.git- Enter the following command to use Pip to install this repository's dependencies.
pip install -r requirements.txtTo use the {project name}, open the command line, navigate to the installation folder and run the following command:
python backstory.pySee the open issues for a list of proposed features (and known issues).
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.
- 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
Distributed under the MIT License. See LICENSE for more information.
Asa LeHolland - [email protected]
Project Link: https://github.com/asa-leholland/{repo-name}
- othneildrew for creating the template README file that was used as the starting point for the README for this project.