1
0
mirror of https://github.com/pdf2htmlEX/pdf2htmlEX.git synced 2024-12-22 13:00:08 +00:00

Merge branch 'master' of github.com:coolwanglu/pdf2htmlEX

This commit is contained in:
Lu Wang 2013-11-20 21:35:57 +08:00
commit cabc5c993e

View File

@ -7,43 +7,39 @@ This document is adapted from [necolas/issue-guidelines](https://github.com/neco
## Table of Contents ## Table of Contents
- [Channels](#channels) - [Channels](#channels)
- [The Issue Tracker](#issue-tracker) - [The Issue Tracker](#the-issue-tracker)
- [The Mailing List](#mailing-list) - [The Mailing List](#the-mailing-list)
- [Contacting the Author](#author) - [Contacting the Author](#contacting-the-author)
- [Guidance](#guide) - [Guidance](#guidance)
- [Ask Questions](#ask-question) - [Ask Questions](#ask-questions)
- [Bug Reports](#bug-report) - [Bug Reports](#bug-reports)
- [Feature Requests](#feature-request) - [Feature Requests](#feature-requests)
- [Pull Requests](#pull-request) - [Pull Requests](#pull-requests)
*** ***
<div id="channels"></div>
## Channels ## Channels
A few channels are available to reach the developers, please find the most proper one for your purpose. A few channels are available to reach the developers, please find the most proper one for your purpose.
<div id="issue-tracker"></div>
### The Issue Tracker ### The Issue Tracker
The [Issue Tracker](https://github.com/coolwanglu/pdf2htmlEX/issues) The [Issue Tracker](https://github.com/coolwanglu/pdf2htmlEX/issues)
is the best way for is the best way for
[bug reports](#bug-report), [bug reports](#bug-reports),
[features requests](#feature-request) [features requests](#feature-requests)
and [submitting pull requests](#pull-request). and [submitting pull requests](#pull-requests).
Please respect the following restrictions: Please respect the following restrictions:
* Do not post personal support requests, (e.g How can I call pdf2htmlEX in Java?). Use the mailing list, or [Stack Overflow](http://stackoverflow.com) instead. * Do not post personal support requests, (e.g How can I call pdf2htmlEX in Java?). Use the mailing list, or [Stack Overflow](http://stackoverflow.com) instead.
* Keep the discussion on topic and respect the opinions of others. * Keep the discussion on topic and respect the opinions of others.
* Posts violating the above restrictions may be removed without any notification. * Posts violating the above restrictions may be removed without any notification.
<div id="mailing-list"></div>
### The Mailing List ### The Mailing List
The [Mailing list](pdf2htmlex@googlegroups.com) is set up for discussion and announcements. The [Mailing list](pdf2htmlex@googlegroups.com) is set up for discussion and announcements.
You are welcome to [ask any question](#ask-question) about pdf2htmlEX there. You are welcome to [ask any question](#ask-questions) about pdf2htmlEX there.
However do not report issues or submit patches there, since it's terrible to keep track of them. However do not report issues or submit patches there, since it's terrible to keep track of them.
<div id="author"></div>
### Contacting the author ### Contacting the author
pdf2htmlEX is mostly written and maintained by 王璐 (Lu Wang). pdf2htmlEX is mostly written and maintained by 王璐 (Lu Wang).
@ -56,13 +52,11 @@ Please post only messages that do not fit into the above channels, for example:
Please expect a _long_ delaysince the messages are usually archived and checked on a regular basis. Please expect a _long_ delaysince the messages are usually archived and checked on a regular basis.
<div id="guidance"></div>
## Guidance ## Guidance
Here are a few tips for different types of messages. Here are a few tips for different types of messages.
Lots of your time may be saved if you follow the guidelines. Lots of your time may be saved if you follow the guidelines.
<div id="ask-question"></div>
### Ask questions ### Ask questions
If you need any help or have issues using pdf2htmlEX, If you need any help or have issues using pdf2htmlEX,
@ -72,13 +66,12 @@ First of all, did you realize that your question might have been already answere
- [pdf2htmlEX Wiki](https://github.com/coolwanglu/pdf2htmlEX/wiki) - [pdf2htmlEX Wiki](https://github.com/coolwanglu/pdf2htmlEX/wiki)
- The manpage (run `man pdf2htmlEX`) - The manpage (run `man pdf2htmlEX`)
- Old posts in the [mailing list](#mailing-list) or the [issue tracker](#issue-tracker) - Old posts in the [mailing list](#the-mailing-list) or the [issue tracker](#the-issue-tracker)
- [Google](http://www.google.com/) - [Google](http://www.google.com/)
If you cannot find anything useful there, do not hesitate to post in the [mailing list](#mailing-list). If you cannot find anything useful there, do not hesitate to post in the [mailing list](#the-mailing-list).
On the other hand, if you think it's something wrong about pdf2htmlEX, please [report a bug](#bug-report) instead. On the other hand, if you think it's something wrong about pdf2htmlEX, please [report a bug](#bug-reports) instead.
<div id="bug-report"></div>
### Bug Reports ### Bug Reports
A bug is a demonstrable problem that is caused by the code in the repository. A bug is a demonstrable problem that is caused by the code in the repository.
A perfect bug report may help the developer to identify the cause and locate the problematic code quickly. A perfect bug report may help the developer to identify the cause and locate the problematic code quickly.
@ -109,7 +102,6 @@ Especially for issues regarding building pdf2htmlEX:
- What's the output of `cmake` and `make`? - What's the output of `cmake` and `make`?
- What's the content of `CMakeList.txt`? - What's the content of `CMakeList.txt`?
<div id="feature-request"></div>
### Feature requests ### Feature requests
Feature requests are welcome. But take a moment to find out whether your idea Feature requests are welcome. But take a moment to find out whether your idea
@ -117,7 +109,6 @@ fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible. provide as much detail and context as possible.
<div id="pull-request"></div>
### Pull requests ### Pull requests
Good pull requests - patches, improvements, new features - are a fantastic Good pull requests - patches, improvements, new features - are a fantastic