Skip to content

Commit efafa80

Browse files
committed
Renamed INSTALL.txt to README.md, edited and converted document to markdown.
1 parent 915a353 commit efafa80

File tree

3 files changed

+41
-49
lines changed

3 files changed

+41
-49
lines changed

resources/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## How to install ##library.name##
2+
3+
### Install with the Contribution Manager
4+
5+
Add contributed libraries by selecting the menu item _Sketch__Import Library...__Add Library..._ This will open the Contribution Manager, where you can browse for ##library.name##, or any other library you want to install.
6+
7+
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.
8+
9+
### Manual Install
10+
11+
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.
12+
13+
By default the following locations are used for your sketchbook folder:
14+
* For Mac users, the sketchbook folder is located inside `~/Documents/Processing`
15+
* For Windows users, the sketchbook folder is located inside `My Documents/Processing`
16+
17+
Download ##library.name## from ##library.url##
18+
19+
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.
20+
21+
The folder structure for library ##library.name## should be as follows:
22+
23+
```
24+
Processing
25+
libraries
26+
##library.name##
27+
examples
28+
library
29+
##library.name##.jar
30+
reference
31+
src
32+
```
33+
34+
Some folders like `examples` or `src` might be missing. After library ##library.name## has been successfully installed, restart the Processing application.
35+
36+
### Troubleshooting
37+
38+
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 [##author.name##](##author.url##).

resources/build.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@
5252
<property name="project.reference" location="reference"/>
5353
<property name="project.dist" location="distribution"/>
5454
<property name="project.dist.version" location="distribution/${project.name}-${library.version}"/>
55-
<property name="install.source" location="resources/install_instructions.txt"/>
56-
<property name="install.destination" location="${project.dist.version}/INSTALL.txt"/>
55+
<property name="install.source" location="resources/README.md"/>
56+
<property name="install.destination" location="${project.dist.version}/README.md"/>
5757
<property name="libprops.source" location="resources/library.properties"/>
5858

5959
<taskdef resource="net/sf/antcontrib/antcontrib.properties">
@@ -292,7 +292,7 @@ ${line}
292292

293293

294294
<target name="generate.install.library" if="is.normal">
295-
<copy file="${install.source}" tofile="${project.dist.version}/INSTALL.txt" />
295+
<copy file="${install.source}" tofile="${install.destination}" />
296296

297297
<antcall target="parse.file"><param name="file" value="${install.destination}"/></antcall>
298298
</target>

resources/install_instructions.txt

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)