workout-generator-cli/README.md

32 lines
1.5 KiB
Markdown
Raw Normal View History

2015-06-20 02:38:34 +00:00
# README #
2015-06-20 17:39:23 +00:00
Python Workout Generator v0.4
2015-06-20 02:38:34 +00:00
### What is this repository for? ###
* A simple python script to generate a random workout based on the number of days per week that the user wants to work out.
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
### How do I get set up? ###
2015-06-21 02:49:56 +00:00
* Make sure you're using Python 3.4.3.
* Fork the repository to a safe location on your hard drive and pull every time you want to work on it.
* Comment out all of the code that you write even if it seems obvious what's going on.
* After you finish what you wanted to work on, commit the changes you made and write a brief message explaining what you did. Then push your changes to the server.
2015-06-20 02:38:34 +00:00
### Contribution guidelines ###
* Comment out all new code additions and write out new additions in commit messages.
### Who do I talk to? ###
2015-06-20 17:39:23 +00:00
* Project Lead: Billy Brawner billybrawner@gmail.com
### Possible future features ###
* Take into account a user's fitness level (beginner, intermediate, advanced) and modify the workout give accordingly.
* Save routine to a file for easy access later.
* Allow user to input how may sets, reps, and weight for each exercise completed in order to track their progress.
* Allow user to substitute individual exercises in their list.
* Remember weight used for each exercise in previous workouts if the user has input them afterwards and suggest the highest weight used for each.
* Convert to a web app or native mobile app for use on phones/tablets (maybe both, since Apple is super strict on their app acceptance policy.)