Skip to content
This repository has been archived by the owner on Feb 27, 2023. It is now read-only.

Commit

Permalink
Update installation section in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix Van der Jeugt committed Aug 22, 2019
1 parent 42f73b1 commit 9a203d8
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
# FragGeneScan++
An improved version of [FragGeneScan-Plus][fgsp].

## Installing
To build/install FragGeneScan++ from source, you will need [Meson][meson]. run the following commands from the source
repository:
A modified fork of [FragGeneScan-Plus][fgsp].

```sh
meson build
ninja -C build
sudo ninja -C build install
```

## Running
An example usage of FragGeneScan++ looks like the following:
## Installation

```
FGS++ -s example/NC_000913-454.fna -o output -w 0 -t 454_5 -p 16
```
The installation instruction from [FGS+][fgsp install] remain valid:

For more info or a list of all options, run FragGeneScan++ without arguments.
1. Install `make` and `gcc`.

2. Clone this repository and go to the repository root.

```sh
git clone https://github.com/unipept/FragGeneScanPlusPlus.git
cd FragGeneScanPlusPlus
```

3. Run `make`.

## Documentation
To get the most recent version of the documentation, issue the following
command:

## Running

An example usage of FragGeneScan++ looks like the following:

```
ninja -C build docs
FGSpp -s example/NC_000913-454.fna -o output -w 0 -t 454_5 -p 16
```

The documentation can then be viewed by opening `build/doc/html/index.html` in
your favorite browser.
For more info or a list of all options, run FragGeneScan++ without arguments.

### Output files

Upon completion, FragGeneScan++ can generate 3 files:

* The `[output_file].faa` file lists amino acid sequences in FASTA format
Expand All @@ -45,7 +44,9 @@ file consists of 5 columns ( _start position_, _end position_, _strand_,
_frame_, and _score_). This file is not automatically generated: to obtain this
file, set the `-e` flag to 1.


## License

FragGeneScan++ is released under under the terms of the GNU General Public
License, version 3 (or any later version), as published by the Free Software
Foundation.
Expand All @@ -55,3 +56,4 @@ Please see the [LICENSE](LICENSE) file for further information.

[fgsp]: https://github.com/hallamlab/FragGeneScanPlus/
[meson]: https://mesonbuild.com/
[fgsp install]: https://github.com/hallamlab/FragGeneScanPlus/wiki#setup-and-dependencies-1

0 comments on commit 9a203d8

Please sign in to comment.