Skip to content
This repository has been archived by the owner on Sep 24, 2019. It is now read-only.

Commit

Permalink
further rebranding for repository and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Anthony Bargnesi committed Jul 28, 2015
1 parent 7460f13 commit 6ec2af0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 17 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
kam-nav
=======
BEL Navigator
=============

Explore OpenBEL knowledge networks within Cytoscape 3.

Expand All @@ -23,32 +23,29 @@ Explore OpenBEL knowledge networks within Cytoscape 3.

*Installation*

**Note**: The *kam-nav* plugin must be installed manually (see [enhancement issue #34](https://github.com/OpenBEL/kam-nav/issues/34)).
**Note**: The *BEL Navigator* plugin must be installed manually (see [enhancement issue #34](https://github.com/OpenBEL/bel-nav/issues/34)).

1. Download current release from [OpenBEL/kam-nav](https://github.com/OpenBEL/kam-nav/releases).
2. Unzip archive into the Cytoscape 3 plugins folder (e.g. CytoscapeConfiguration/3/apps/installed):

- Windows path: %UserProfile%\CytoscapeConfiguration\3\apps\installed
- Mac/Linux path: $HOME/CytoscapeConfiguration/3/apps/installed

3. Start Cytoscape.
1. Download current release from [OpenBEL/bel-nav](https://github.com/OpenBEL/bel-nav/releases).
2. Start Cytoscape.
3. Go to Apps ➡ App Manager ➡ Install from File...
4. Select the downloaded JAR and click *Install*.

*Development*

The *kam-nav* plugin is built with Groovy and uses a maven build system.
The *BEL Navigator* plugin is built with Groovy and uses a maven build system.

Additionally it includes the [gosh](https://github.com/formwork-io/gosh) shell tool to drive development functions. This shell tool is based on bash so it works within Mac, Linux, and Windows w/ Cygwin.

An isolated version of Cytoscape 3 is included in the repository to ease development. This enables plugins to automatically reload within Cytoscape after a build or test cycle succeeds.

To get started follow these steps:

1. Clone repository: `git clone [email protected]:OpenBEL/kam-nav.git`
1. Clone repository: `git clone [email protected]:OpenBEL/bel-nav.git`
2. Install maven.
3. Execute the `go.sh` shell script.

```bash
[tony@starship kam-nav]$ ./go.sh
[tony@starship bel-nav]$ ./go.sh

Entering go shell, [CTRL-C] to exit.

Expand Down
8 changes: 4 additions & 4 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@
</developers>

<scm>
<connection>scm:git:git://github.com/OpenBEL/kam-nav.git</connection>
<developerConnection>scm:git:git://github.com/OpenBEL/kam-nav.git</developerConnection>
<url>https://github.com/OpenBEL/kam-nav/</url>
<connection>scm:git:git://github.com/OpenBEL/bel-nav.git</connection>
<developerConnection>scm:git:git://github.com/OpenBEL/bel-nav.git</developerConnection>
<url>https://github.com/OpenBEL/bel-nav/</url>
</scm>

<issueManagement>
<url>https://github.com/OpenBEL/kam-nav/issues/</url>
<url>https://github.com/OpenBEL/bel-nav/issues/</url>
</issueManagement>

<build>
Expand Down

0 comments on commit 6ec2af0

Please sign in to comment.