Skip to content

README.md

Latest commit

 

History

History
74 lines (48 loc) · 2.39 KB

README.md

File metadata and controls

74 lines (48 loc) · 2.39 KB

Python Portraits

Version: 0.0.3

Live Website

Made for the 2017 UMW Hackathon

The purpose of this project is to create a lightweight web application that allows for python code to be visually represented on a canvas.

We will be adding a documents folder soon for information not found in this document.

How it works

Section Coming Soon

How to add a drawing algorithm

Files to edit

There will be an in-depth guide to creating a new drawing algorithm once we clean up and optimize the code a little. Hold Tight!

Main ingredients

  • Yarn - Package manager.
  • jQuery - JavaScript library.
  • Bootstrap - Toolkit for developing with HTML, CSS, and JS.
  • Bootstrap-select - jQuery plugin that utilizes Bootstrap's dropdown.js to style and bring additional functionality to standard select elements.
  • Font-Awesome - Scalable vector icons.
  • p5.js - a library and set of tools that make it easy to use the JavaScript programming language for creative coding.

How to use Yarn

Yarn should not be necessary to install dependancies since the node_modules folder is on github.

Please see the Yarn webpage to get it installed on your local machine as well as seeing as examples of how to use Yarn.

Make sure that node.js is installed before installing Yarn.

Once Yarn is installed, run "yarn" in order to get all package components.

$ yarn

Add packages using "yarn add".

$ yarn add <PACKAGE NAME>
$ yarn add bootstrap

Remove packages using "yarn remove".

$ yarn remove <PACKAGE NAME>
$ yarn remove bootstrap

Contributing

Project members

Read CONTRIBUTORS.md for details on what each member contributed to the project.

Read CONTRIBUTING.md for details on how to contribute code to the repository.

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

Please acknowledge us in some way if you use any of this code.