Skip to content

Commit 4776115

Browse files
Documentation was added
1 parent b841d49 commit 4776115

9 files changed

+1071
-0
lines changed

docs/How-to-propose-a-PR.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
...under construction

docs/How-to-report-an-issue.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
... under construction

docs/Installing-the-project.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[Download the jar from Maven](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22io.appium%22%20AND%20a%3A%22java-client%22) or add the following to pom.xml:
2+
3+
```
4+
<dependency>
5+
<groupId>io.appium</groupId>
6+
<artifactId>java-client</artifactId>
7+
<version>3.4.1</version>
8+
</dependency>
9+
```
10+
11+
It currently depends on selenium-java 2.53.0. If it is necessary to use another version of Selenium then you can configure pom.xml as follows:
12+
13+
```
14+
<dependency>
15+
<groupId>io.appium</groupId>
16+
<artifactId>java-client</artifactId>
17+
<version>3.4.1</version>
18+
<exclusions>
19+
<exclusion>
20+
<groupId>org.seleniumhq.selenium</groupId>
21+
<artifactId>selenium-java</artifactId>
22+
</exclusion>
23+
</exclusions>
24+
</dependency>
25+
26+
<dependency>
27+
<groupId>org.seleniumhq.selenium</groupId>
28+
<artifactId>selenium-java</artifactId>
29+
<version>${selenium.version.you.require}</version>
30+
</dependency>
31+
```

docs/Note-for-developers.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Coding Standards
2+
3+
Appium java-client strictly follows [Google Java Style](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html) as a coding standards. Contributors are requested to follow this by configuring in their IDE's Editor Code style,
4+
5+
* Clone [Google Style Guide](https://github.com/google/styleguide.git) from git
6+
7+
**Intellij IDEA** user's can configure this way,
8+
`Files -> Other Settings -> Default Settings ->Editor -> Code Style -> Manage -> Manage -> Import -> eclipse-java-google-style.xml (Downloaded from Google Style Guide)-> Apply`
9+
10+
**Eclipse IDE** user's can configure this way,
11+
`Preferences -> Java -> Code Style -> Formatter -> Import -> eclipse-java-google-style.xml (Downloaded from Google Style Guide)-> Apply`
12+
13+
Reformat your code before raising a Pull Request.

0 commit comments

Comments
 (0)