Skip to content

Commit a01de84

Browse files
committed
Create about, get started and FAQs pages
1 parent 48098b3 commit a01de84

File tree

3 files changed

+64
-36
lines changed

3 files changed

+64
-36
lines changed

_wiki/BioJava_GetStarted.md

+28-36
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,57 @@
11
---
2-
title: BioJava:GetStarted
2+
title: Get Started
33
permalink: wiki/BioJava%3AGetStarted
44
---
55

66
Introduction
77
------------
88

99
BioJava will run on any computer with a Java virtual machine complying
10-
to the Java 2 Standard Edition (J2SE) 1.6 (or later) specifications.
10+
to the Java specifications.
1111
Java implementations for Linux, Windows, and Solaris are available to
1212
download from [Oracle's java
1313
website](http://www.oracle.com/technetwork/java/). Recent versions of
1414
MacOS X include a suitable Java implementation as standard. Java is also
1515
available on many other platforms: if in doubt, contact your vendor.
1616
BioJava binaries are distributed in .jar (Java ARchive) format.
1717

18-
You can get the latest version of BioJava3+ from the download page
19-
[BioJava (v) (requires Java 1.6+)](/wiki/BioJava:Download "wikilink").
18+
Obtain BioJava
19+
--------------
2020

21-
You can get the latest version of BioJava-legacy (a.k.a. BioJava1) from
22-
the download page [BioJava1 (v) (requires Java
23-
1.5+)](/wiki/BioJava:Download_{{site.release.legacy}} "wikilink").
21+
BioJava is open-source and entirely hosted on [GitHub](https://github.com/biojava/biojava). You can check the code, submit issues and pull requests and download latest and past release binaries from GitHub.
2422

25-
You can also integrate BioJava with NetBeans IDE. To find out how follow
26-
this [link](/wiki/How_to_integrate_BioJava_in_NetBeans_IDE "wikilink").
23+
You can manually download the latest version of BioJava ({{site.release.version}}), which requires Java 1.8+, from the [GitHub releases page](https://github.com/biojava/biojava/releases), but continue reading this article for a more convenient solution to integrate BioJava into your project.
2724

28-
A step by step guide on 'How to integrate BioJava in Netbeans IDE' is
29-
[here](/wiki/BioJava-Installation_Guide.png "wikilink").
25+
For instructions on how to obtain the BioJava-legacy (a.k.a. BioJava1), which requires Java 1.5+, follow [this link](BioJava%3AGetStartedLegacy) or check the [biojava-legacy](https://github.com/biojava/biojava-legacy) project on GitHub.
3026

31-
Maven
32-
-----
27+
Quick Installation
28+
------------------
3329

3430
BioJava uses [Maven](http://maven.apache.org/) as a build and
35-
distribution system. If you are new to Maven, take a look at the
31+
distribution system. If you are new to Maven and want to find out more about it (although most details are not required for using BioJava), take a look at the
3632
[Getting Started with
3733
Maven](http://maven.apache.org/guides/getting-started/index.html) guide.
3834

39-
BioJava, as of release 4.0.0 is available through Maven Central.
35+
BioJava is available through [Maven Central](https://mvnrepository.com/artifact/org.biojava), so if you are using Maven to build your Java project you can import BioJava by adding the following XML to your project pom.xml file:
4036

41-
You can add the BioJava repository by adding the following XML to your
42-
project pom.xml file:
37+
```xml
38+
<dependencies>
39+
<dependency>
40+
<groupId>org.biojava</groupId>
41+
<artifactId>biojava-core</artifactId>
42+
<version>{{site.release.version}}</version>
43+
</dependency>
44+
<!-- other biojava jars as needed -->
45+
</dependencies>
46+
```
4347

48+
More options can be found in the [README](https://github.com/biojava/biojava) of the GitHub repository.
4449

45-
<dependencies>
46-
...
47-
<dependency>
48-
<groupId>org.biojava</groupId>
49-
<artifactId>biojava-core</artifactId>
50-
<version>{{site.release.version}}</version>
51-
</dependency>
52-
<!-- other biojava jars as needed -->
53-
</dependencies>
5450

51+
Manual Installation
52+
-------------------
5553

56-
Installation
57-
------------
58-
59-
None of these .jar files need to be unpacked for normal use -- simply
54+
None of the BioJava .jar files need to be unpacked for normal use - simply
6055
place them in a convenient directory.
6156

6257
To use BioJava, add the required JAR files to your CLASSPATH environment
@@ -79,10 +74,7 @@ below).
7974
Building your own
8075
-----------------
8176

82-
If you want to modify BioJava, you can obtain a copy of the source code
83-
from the download areas. Source releases are distributed in .tar.gz
84-
format. You can also obtain up-to-the-minute source code via either the
85-
[Maven repository](http://biojava.org/download/maven/) or from
86-
[github](Get source "wikilink").
77+
If you want to modify BioJava, you can clone or fork the GitHub repository or obtain the source code from any of the previous releases from the [releases page](https://github.com/biojava/biojava/releases).
78+
Source releases are distributed in .tar.gz format.
8779

88-
BioJava is now built using [Apache Maven](http://maven.apache.org/).
80+
If you think your modifications can benefit others do not hesitate to submit a [pull request on GitHub](https://github.com/biojava/biojava/pulls). We always welcome new contributions. Here is how you can [get involved]({{site.baseurl}}/getinvolved.html).

_wiki/FAQs.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Frequently Asked Questions
3+
permalink: wiki/FAQs
4+
---
5+
6+
**Q: Which macromolecular structure formats does BioJava support?**
7+
A: Currently BioJava supports parsing macromolecular structures in [PDB](https://www.rcsb.org/pdb/static.do?p=file_formats/pdb/index.html), [MMCIF](https://www.rcsb.org/pdb/static.do?p=file_formats/mmcif/index.html) and, as of version 5+, [MMTF](http://mmtf.rcsb.org/).
8+
The library also allows conversion between the formats through the same internal representation as `Structure` objects.
9+
10+
**Q: How often are new versions of BioJava released?**
11+
A: There is not a fixed schedule for BioJava releases. Minor versions are released when there are important bug fixes to include, and as a fact we have released two major versions in the last six years.
12+
13+
**Q: I love the library, how can I support you?**
14+
A: Thanks! We are simple people, so just consider giving us a star in the [GitHub repository](https://github.com/biojava/biojava/stargazers) and [citing the project]({{site.baseurl}}/about.html) if it was useful in your research.

_wiki/GetInvolved.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Get involved
3+
permalink: wiki/GetInvolved
4+
---
5+
6+
Become a contributor
7+
--------------------
8+
9+
BioJava is made possible thanks to its diverse [developer community](https://github.com/biojava/biojava/graphs/contributors).
10+
We always welcome new contributors, no matter the type or extent of the contributions.
11+
12+
If you already have some ideas or suggestions to improve the library, submit a new [issue](https://github.com/biojava/biojava/issues) or [pull request](https://github.com/biojava/biojava/pulls) on GitHub.
13+
14+
Alternatively, you can explore some of the known [bugs](https://github.com/biojava/biojava/issues?q=is%3Aissue+is%3Aopen+label%3Abug) that need fixing or [feature requests](https://github.com/biojava/biojava/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+feature%22) from other users.
15+
If you are unsure, contact us and we might be able to point out the ones suitable for newcomers and students.
16+
17+
Stay tuned
18+
----------
19+
20+
There are two channels to contact the BioJava community and stay in touch (it is that simple!):
21+
1. Watch (and star!) the main [BioJava GitHub](https://github.com/biojava/biojava) repository and participate in the discussions.
22+
2. Subscribe to the biojava-l mailing list [here](http://lists.open-bio.org/mailman/listinfo/biojava-l) and send an e-mail to [biojava-l@biojava.org](mailto:biojava-l@biojava.org).

0 commit comments

Comments
 (0)