Skip to content

Commit f900082

Browse files
amedeeamedee
committed
Add readme
0 parents  commit f900082

File tree

9 files changed

+1306
-0
lines changed

9 files changed

+1306
-0
lines changed

‎.gitattributes

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Set the default behavior, in case people don't have core.autocrlf set.
2+
* text=auto
3+
4+
# Explicitly declare text files you want to always be normalized and converted
5+
# to LF line endings on checkout.
6+
*.afm text eol=lf
7+
*.cmap text eol=lf
8+
*.crt text eol=lf
9+
*.cs text eol=lf
10+
*.html text eol=lf
11+
*.java text eol=lf ident
12+
*.lng text eol=lf
13+
*.md text eol=lf
14+
*.pom text eol=lf
15+
*.properties text eol=lf
16+
*.txt text eol=lf
17+
*.xfdf text eol=lf
18+
*.xml text eol=lf
19+
20+
# Declare files that will always have CRLF line endings on checkout.
21+
*.bat text eol=crlf
22+
*.csproj text eol=crlf
23+
*.sln text eol=crlf
24+
25+
# Denote all files that are truly binary and should not be modified.
26+
*.bmp binary
27+
*.cmp binary
28+
*.dib binary
29+
*.gif binary
30+
*.j2k binary
31+
*.jb2 binary
32+
*.jp2 binary
33+
*.jpg binary
34+
*.key binary
35+
*.otf binary
36+
*.pdf binary
37+
*.pfb binary
38+
*.png binary
39+
*.tif binary
40+
*.tiff binary
41+
*.ttc binary
42+
*.ttf binary
43+
*.wmf binary

‎.gitignore

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# Created by https://www.gitignore.io
2+
3+
### Java ###
4+
*.class
5+
6+
# Mobile Tools for Java (J2ME)
7+
.mtj.tmp/
8+
9+
# Package Files #
10+
*.jar
11+
*.war
12+
*.ear
13+
14+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
15+
hs_err_pid*
16+
17+
18+
### Eclipse ###
19+
*.pydevproject
20+
.metadata
21+
.gradle
22+
bin/
23+
tmp/
24+
*.tmp
25+
*.bak
26+
*.swp
27+
*~.nib
28+
local.properties
29+
.settings/
30+
.loadpath
31+
32+
# Eclipse Core
33+
.project
34+
35+
# External tool builders
36+
.externalToolBuilders/
37+
38+
# Locally stored "Eclipse launch configurations"
39+
*.launch
40+
41+
# CDT-specific
42+
.cproject
43+
44+
# JDT-specific (Eclipse Java Development Tools)
45+
.classpath
46+
47+
# PDT-specific
48+
.buildpath
49+
50+
# sbteclipse plugin
51+
.target
52+
53+
# TeXlipse plugin
54+
.texlipse
55+
56+
57+
### Intellij ###
58+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
59+
60+
*.iml
61+
62+
## Directory-based project format:
63+
.idea/
64+
# if you remove the above rule, at least ignore the following:
65+
66+
# User-specific stuff:
67+
# .idea/workspace.xml
68+
# .idea/tasks.xml
69+
# .idea/dictionaries
70+
71+
# Sensitive or high-churn files:
72+
# .idea/dataSources.ids
73+
# .idea/dataSources.xml
74+
# .idea/sqlDataSources.xml
75+
# .idea/dynamic.xml
76+
# .idea/uiDesigner.xml
77+
78+
# Gradle:
79+
# .idea/gradle.xml
80+
# .idea/libraries
81+
82+
# Mongo Explorer plugin:
83+
# .idea/mongoSettings.xml
84+
85+
## File-based project format:
86+
*.ipr
87+
*.iws
88+
89+
## Plugin-specific files:
90+
91+
# IntelliJ
92+
out/
93+
94+
# mpeltonen/sbt-idea plugin
95+
.idea_modules/
96+
97+
# JIRA plugin
98+
atlassian-ide-plugin.xml
99+
100+
# Crashlytics plugin (for Android Studio and IntelliJ)
101+
com_crashlytics_export_strings.xml
102+
crashlytics.properties
103+
crashlytics-build.properties
104+
105+
106+
### NetBeans ###
107+
nbproject/private/
108+
build/
109+
nbbuild/
110+
dist/
111+
nbdist/
112+
nbactions.xml
113+
nb-configuration.xml
114+
.nb-gradle/
115+
116+
117+
### Linux ###
118+
*~
119+
120+
# KDE directory preferences
121+
.directory
122+
123+
# Linux trash folder which might appear on any partition or disk
124+
.Trash-*
125+
126+
127+
### Windows ###
128+
# Windows image file caches
129+
Thumbs.db
130+
ehthumbs.db
131+
132+
# Folder config file
133+
Desktop.ini
134+
135+
# Recycle Bin used on file shares
136+
$RECYCLE.BIN/
137+
138+
# Windows Installer files
139+
*.cab
140+
*.msi
141+
*.msm
142+
*.msp
143+
144+
# Windows shortcuts
145+
*.lnk
146+
147+
target/
148+
nbactions*.xml
149+
.checkstyle
150+
.pmd
151+
.pmdruleset.xml
152+
153+
# Ignore generated files
154+
filmfestival.log
155+
156+
.vagrant/

‎BUILDING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
To build **pdfSweep**, [Maven][1] must be installed.
2+
3+
Running install without a profile will generate the **pdfSweep** jars:
4+
```bash
5+
$ mvn clean install \
6+
-Dmaven.test.skip=true \
7+
-Dmaven.javadoc.failOnError=false \
8+
> >(tee mvn.log) 2> >(tee mvn-error.log >&2)
9+
```
10+
11+
To run the tests, [Ghostscript][2] and [Imagemagick][3] must be installed.
12+
```bash
13+
$ mvn clean install \
14+
-Dmaven.test.failure.ignore=false \
15+
-DgsExec=$(which gs) \
16+
-DcompareExec=$(which compare) \
17+
-Dmaven.javadoc.failOnError=false \
18+
> >(tee mvn.log) 2> >(tee mvn-error.log >&2)
19+
```
20+
21+
You can use the supplied `Vagrantfile` to get a [Vagrant][4] VM ([Ubuntu][5] 14.04 LTS - Trusty Tahr, with [VirtualBox][6]) with all the required software installed.
22+
```bash
23+
$ vagrant box add ubuntu/trusty64
24+
$ vagrant up
25+
$ vagrant ssh -- \
26+
'cd /vagrant ; mvn clean install -Dmaven.test.skip=true -Dmaven.javadoc.failOnError=false' \
27+
> >(tee mvn.log) 2> >(tee mvn-error.log >&2)
28+
```
29+
30+
[1]: http://maven.apache.org/
31+
[2]: http://www.ghostscript.com/
32+
[3]: http://www.imagemagick.org/
33+
[4]: https://www.vagrantup.com/
34+
[5]: http://www.ubuntu.com/
35+
[6]: https://www.virtualbox.org/

‎CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at http://itextpdf.com/contact. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)