Skip to content

Commit 16a6baa

Browse files
Merge pull request #1 from chowmean/main
Adding contribution guide and cosmetics changes
2 parents 1fd95f4 + 58bd9c7 commit 16a6baa

File tree

1 file changed

+61
-4
lines changed

1 file changed

+61
-4
lines changed

readme.md

+61-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[![](https://jitpack.io/v/tech-pw/RenderX.svg)](https://jitpack.io/#tech-pw/RenderX)
22

3-
**Title: An Native Android library to render latex with HTML support**
3+
# Native Android library to render latex with HTML support
44

5-
**Introduction:**
5+
## Introduction
66
In the realm of Android development, the struggle with sluggish equation rendering has been all too real. RenderX steps into the spotlight as a game-changing solution, not only accelerating LaTeX rendering but also seamlessly handling HTML with a nuanced fallback mechanism.
77

8-
**The Dual Power of RenderX:**
8+
#### The Dual Power of RenderX
99

1010
1. **Native Rendering Excellence:**
1111
- Bid farewell to the performance bottlenecks associated with webviews. RenderX champions native rendering, dramatically enhancing the speed of LaTeX equation display on Android. Our benchmark tests reveal a 50-80% improvement, translating to a more responsive user experience.
@@ -55,7 +55,7 @@ Output
5555
4. **Intelligent Fallback Mechanism:**
5656
- In complex scenarios where native rendering faces challenges, RenderX gracefully falls back to webview, so that it can be used in production ready usecases, ensuring a seamless user experience.
5757

58-
**Integration Guide: Bringing pwHtml Latex Into Your Project:**
58+
## Integration Guide: Bringing pwHtml Latex Into Your Project:
5959
1) For new project system following has to be added to setting.gradle and for old system it has to be added to root level build.gradle
6060

6161
```
@@ -79,5 +79,62 @@ dependencies {
7979
8080
```
8181

82+
# Contributing
8283

84+
When contributing to this repository, please first discuss the change you wish to make via issue, or any other method with the owners of this repository before making a change.
8385

86+
Please note we have a code of conduct, please follow it in all your interactions with the project.
87+
88+
## Pull Request Process
89+
90+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
91+
build.
92+
2. Update the README.md with details of changes to the interface, this includes new environment
93+
variables, exposed ports, useful file locations and container parameters.
94+
3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
95+
do not have permission to do that, you may request the second reviewer to merge it for you.
96+
97+
## Code of Conduct
98+
99+
### Our Pledge
100+
101+
In the interest of fostering an open and welcoming environment, we as
102+
contributors and maintainers pledge to making participation in our project and
103+
our community a harassment-free experience for everyone, regardless of age, body
104+
size, disability, ethnicity, gender identity and expression, level of experience,
105+
nationality, personal appearance, race, religion, or sexual identity and
106+
orientation.
107+
108+
### Our Standards
109+
110+
Examples of behavior that contributes to creating a positive environment
111+
include:
112+
113+
* Using welcoming and inclusive language
114+
* Being respectful of differing viewpoints and experiences
115+
* Gracefully accepting constructive criticism
116+
* Focusing on what is best for the community
117+
* Showing empathy towards other community members
118+
119+
Examples of unacceptable behavior by participants include:
120+
121+
* The use of sexualized language or imagery and unwelcome sexual attention or
122+
advances
123+
* Trolling, insulting/derogatory comments, and personal or political attacks
124+
* Public or private harassment
125+
* Publishing others' private information, such as a physical or electronic
126+
address, without explicit permission
127+
* Other conduct which could reasonably be considered inappropriate in a
128+
professional setting
129+
130+
### Our Responsibilities
131+
132+
Project maintainers are responsible for clarifying the standards of acceptable
133+
behavior and are expected to take appropriate and fair corrective action in
134+
response to any instances of unacceptable behavior.
135+
136+
Project maintainers have the right and responsibility to remove, edit, or
137+
reject comments, commits, code, wiki edits, issues, and other contributions
138+
that are not aligned to this Code of Conduct, or to ban temporarily or
139+
permanently any contributor for other behaviors that they deem inappropriate,
140+
threatening, offensive, or harmful.

0 commit comments

Comments
 (0)