Skip to content

Commit

Permalink
added distribution files
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelAl committed Aug 5, 2020
1 parent 72b4ef1 commit 98e930f
Show file tree
Hide file tree
Showing 9 changed files with 512 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
bin
tmp
distribution

38 changes: 38 additions & 0 deletions distribution/SQuelized-1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## How to install SQuelized

### Install with the Contribution Manager

Add contributed Libraries by selecting the menu item _Sketch__Import Library...__Add Library..._ This will open the Contribution Manager, where you can browse for SQuelized, or any other Library you want to install.

Not all available Libraries have been converted to show up in this menu. If a Library isn't there, it will need to be installed manually by following the instructions below.

### Manual Install

Contributed Libraries may be downloaded separately and manually placed within the `libraries` folder of your Processing sketchbook. To find (and change) the Processing sketchbook location on your computer, open the Preferences window from the Processing application (PDE) and look for the "Sketchbook location" item at the top.

By default the following locations are used for your sketchbook folder:
* For Mac users, the sketchbook folder is located inside `~/Documents/Processing`
* For Windows users, the sketchbook folder is located inside `My Documents/Processing`

Download SQuelized from https://samuelal.github.io/squelized.github.io/index.html

Unzip and copy the contributed Library's folder into the `libraries` folder in the Processing sketchbook. You will need to create this `libraries` folder if it does not exist.

The folder structure for Library SQuelized should be as follows:

```
Processing
libraries
SQuelized
examples
library
SQuelized.jar
reference
src
```
Some folders like `examples` or `src` might be missing. After Library SQuelized has been successfully installed, restart the Processing application.

### Troubleshooting

If you're having trouble, have a look at the [Processing Wiki](https://github.com/processing/processing/wiki/How-to-Install-a-Contributed-Library) for more information, or contact the author [Samuel Alarco Cantos](https://samuelal.github.io/squelized.github.io/index.html).
57 changes: 57 additions & 0 deletions distribution/SQuelized-1/download/SQuelized-1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# More on this file here: https://github.com/processing/processing/wiki/Library-Basics
# UTF-8 supported.

# The name of your Library as you want it formatted.
name = SQuelized

# List of authors. Links can be provided using the syntax [author name](url).
authors = [Samuel Alarco Cantos](https://samuelal.github.io/squelized.github.io/index.html)

# A web page for your Library, NOT a direct link to where to download it.
url = https://samuelal.github.io/squelized.github.io/index.html

# The category (or categories) of your Library, must be from the following list:
# "3D" "Animation" "Compilations" "Data"
# "Fabrication" "Geometry" "GUI" "Hardware"
# "I/O" "Language" "Math" "Simulation"
# "Sound" "Utilities" "Typography" "Video & Vision"
#
# If a value other than those listed is used, your Library will listed as
# "Other". Many categories must be comma-separated.
categories = Data

# A short sentence (or fragment) to summarize the Library's function. This will
# be shown from inside the PDE when the Library is being installed. Avoid
# repeating the name of your Library here. Also, avoid saying anything redundant
# like mentioning that it's a Library. This should start with a capitalized
# letter, and end with a period.
sentence = A library to ease the connection between Processing and SQL databases.

# Additional information suitable for the Processing website. The value of
# 'sentence' always will be prepended, so you should start by writing the
# second sentence here. If your Library only works on certain operating systems,
# mention it here.
paragraph =

# Links in the 'sentence' and 'paragraph' attributes can be inserted using the
# same syntax as for authors.
# That is, [here is a link to Processing](http://processing.org/)

# A version number that increments once with each release. This is used to
# compare different versions of the same Library, and check if an update is
# available. You should think of it as a counter, counting the total number of
# releases you've had.
version = 1 # This must be parsable as an int

# The version as the user will see it. If blank, the version attribute will be
# used here. This should be a single word, with no spaces.
prettyVersion = 1.0.0 # This is treated as a String

# The min and max revision of Processing compatible with your Library.
# Note that these fields use the revision and not the version of Processing,
# parsable as an int. For example, the revision number for 2.2.1 is 227.
# You can find the revision numbers in the change log: https://raw.githubusercontent.com/processing/processing/master/build/shared/revisions.txt
# Only use maxRevision (or minRevision), when your Library is known to
# break in a later (or earlier) release. Otherwise, use the default value 0.
minRevision = 0
maxRevision = 0
Binary file added distribution/SQuelized-1/download/SQuelized-1.zip
Binary file not shown.
57 changes: 57 additions & 0 deletions distribution/SQuelized-1/download/SQuelized-latest.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# More on this file here: https://github.com/processing/processing/wiki/Library-Basics
# UTF-8 supported.

# The name of your Library as you want it formatted.
name = SQuelized

# List of authors. Links can be provided using the syntax [author name](url).
authors = [Samuel Alarco Cantos](https://samuelal.github.io/squelized.github.io/index.html)

# A web page for your Library, NOT a direct link to where to download it.
url = https://samuelal.github.io/squelized.github.io/index.html

# The category (or categories) of your Library, must be from the following list:
# "3D" "Animation" "Compilations" "Data"
# "Fabrication" "Geometry" "GUI" "Hardware"
# "I/O" "Language" "Math" "Simulation"
# "Sound" "Utilities" "Typography" "Video & Vision"
#
# If a value other than those listed is used, your Library will listed as
# "Other". Many categories must be comma-separated.
categories = Data

# A short sentence (or fragment) to summarize the Library's function. This will
# be shown from inside the PDE when the Library is being installed. Avoid
# repeating the name of your Library here. Also, avoid saying anything redundant
# like mentioning that it's a Library. This should start with a capitalized
# letter, and end with a period.
sentence = A library to ease the connection between Processing and SQL databases.

# Additional information suitable for the Processing website. The value of
# 'sentence' always will be prepended, so you should start by writing the
# second sentence here. If your Library only works on certain operating systems,
# mention it here.
paragraph =

# Links in the 'sentence' and 'paragraph' attributes can be inserted using the
# same syntax as for authors.
# That is, [here is a link to Processing](http://processing.org/)

# A version number that increments once with each release. This is used to
# compare different versions of the same Library, and check if an update is
# available. You should think of it as a counter, counting the total number of
# releases you've had.
version = 1 # This must be parsable as an int

# The version as the user will see it. If blank, the version attribute will be
# used here. This should be a single word, with no spaces.
prettyVersion = 1.0.0 # This is treated as a String

# The min and max revision of Processing compatible with your Library.
# Note that these fields use the revision and not the version of Processing,
# parsable as an int. For example, the revision number for 2.2.1 is 227.
# You can find the revision numbers in the change log: https://raw.githubusercontent.com/processing/processing/master/build/shared/revisions.txt
# Only use maxRevision (or minRevision), when your Library is known to
# break in a later (or earlier) release. Otherwise, use the default value 0.
minRevision = 0
maxRevision = 0
Binary file not shown.
19 changes: 19 additions & 0 deletions distribution/SQuelized-1/examples/Hello/Hello.pde
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import template.library.*;

HelloLibrary hello;

void setup() {
size(400,400);
smooth();

hello = new HelloLibrary(this);

PFont font = createFont("",40);
textFont(font);
}

void draw() {
background(0);
fill(255);
text(hello.sayHello(), 40, 200);
}
137 changes: 137 additions & 0 deletions distribution/SQuelized-1/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>SQuelized</title>
<meta name="description" content="A Library for the Processing programming environment" />
<meta name="keywords" content="processing.org, library, ?" />
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Language" content="en-us" />
<meta name="ROBOTS" content="index,follow,archive" />
<meta http-equiv="imagetoolbar" content="false" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="author" content="Samuel Alarco Cantos" />
<meta name="Rating" content="General" />
<meta name="revisit-after" content="7 Days" />
<meta name="doc-class" content="Living Document" />
<link rel="stylesheet" type="text/css" href="./stylesheet.css">
</head>
<body>
<div id="container">

<div id="header">
<h1>SQuelized</h1>
</div>

<div id="menu" class="clear">
<ul>
<li><a href="#about">About</a> \ </li>
<li><a href="#download">Download</a> \ </li>
<li><a href="#download">Installation</a> \ </li>
<li><a href="#examples">Examples</a> \ </li>
<li><a href="./reference/index.html" target="_blank">Reference</a></li>
<!-- <li><a href="#demos">Demos</a> \ </li> -->
<!-- <li><a href="#misc">Misc</a> \ </li> -->
<!-- <li><a href="#images">Images</a> \ </li> -->
</ul>
</div>

<div id="content" class="clear">

<div id="about">
<h2>SQuelized</h2>
<p>
A Library by <a href="https://samuelal.github.io/squelized.github.io/index.html">Samuel Alarco Cantos</a> for the <a href="http://www.processing.org" target="_blank">Processing</a> programming environment.<br>
Last update, 07/30/2020.
</p>
<p>
A library to facilitate the connection between Processing and SQL databases.<br>
<br>
Feel free to replace this paragraph with a description of the Library.<br>
Contributed Libraries are developed, documented, and maintained by members of the Processing community. Further directions are included with each Library. For feedback and support, please post to the Discourse. We strongly encourage all Libraries to be open source, but not all of them are.
</p>
</div>



<div id="download" class="clear">
<h2>Download</h2>
<p>
Download SQuelized version 1.0.0 (1) in
<a href="./download/SQuelized-1.zip">.zip format</a>.
</p>
<h2>Installation</h2>
<p>
Unzip and put the extracted SQuelized folder into the libraries folder of your Processing sketches. Reference and examples are included in the SQuelized folder.
</p>
</div>


<div id="resources">
<p><strong>Keywords</strong>. ?</p>
<p><strong>Reference</strong>. Have a look at the javadoc reference <a href="./reference/index.html" target="_blank">here</a>. A copy of the reference is included in the .zip as well.</p>
<p><strong>Source</strong>. The source code of SQuelized is available at <a href="https://github.com/SamuelAl/SQuelized-for-Processing">GitHub</a>, and its repository can be browsed <a href="https://github.com/SamuelAl/SQuelized-for-Processing.git" target="_blank">here</a>.</p>
</div>


<div id="examples" class="clear">
<h2>Examples</h2>
<p>Find a list of examples in the current distribution of SQuelized, or have a look at them by following the links below.</p>
<ul>
<li><a href="examples/Hello/Hello.pde">Hello</a></li>
</ul>
</div>


<div id="info">
<h2>Tested</h2>
<p>
<!-- on which platform has the Library been tested? -->
<strong>Platform</strong> osx,windows

<!-- which processing version did you use for testing your Library? -->
<br /><strong>Processing</strong> 3.2.3

<!-- does your Library depend on any other Library or framework? -->
<br /><strong>Dependencies</strong> ?
</p>
</div>


<!-- use the demos section for a list of applets run in a browser. -->
<!--
<div id="demos" class="clear">
<h2>demos</h2>
<p>
find a list of online applet demos below.
<ul>
<li><a href="./applets/demo/index.html">demo</a></li>
</ul>
</p>
</div>
-->

<!-- use the misc section for other relevant information. Activate the link to the misc section in the menu above. -->
<!--
<div id="misc" class="clear">
<p></p>
</div>
-->

<!-- use the images/screenshots section. Activate the link to the misc section in the menu above. -->
<!--
<div id="images" class="clear">
</div>
-->


<br class="clear" />
</div>

<div id="footer">
<p>by Samuel Alarco Cantos, (c) 2020.</p>
</div>
</div>
</body>
</html>
Loading

0 comments on commit 98e930f

Please sign in to comment.