Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
chungongyu committed Jun 17, 2020
2 parents 2ff2d97 + a049b39 commit 65ca637
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 9 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Build Status](https://travis-ci.org/chungongyu/siga.svg?branch=master)](https://travis-ci.org/chungongyu/siga)
![GitHub release](https://img.shields.io/github/release/chungongyu/siga.svg)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
[![GitHub license](https://img.shields.io/github/license/chungongyu/siga.svg)](https://github.com/chungongyu/siga)
[![GitHub issues](https://img.shields.io/github/issues/chungongyu/siga.svg)](https://github.com/chungongyu/siga/issues)

Expand Down
3 changes: 3 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@
title: SIGA
description: An open-source de novo assembly toolkit containing various assembly pipelines.
baseurl: "/siga" # the subpath of your site, e.g. /blog
url: "http:https://bioinfo.ict.ac.cn"
show_downloads: true
google_analytics: "UA-131018484-1"
favicon: "favicon.png"
#github: [metadata]
github:
repository_url: https://github.com/chungongyu/siga
Expand Down
64 changes: 64 additions & 0 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">

<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,maximum-scale=2">
{% if site.favicon %}
<link rel="shortcut icon" type="image/x-png" href="{{ site.favicon | relative_url }}">
{% endif %}
<link rel="stylesheet" type="text/css" media="screen" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">

<title>{{ site.title | default: site.github.repository_name }} | {{ site.description | default: site.github.project_tagline }}</title>
{% seo title=false %}
</head>

<body>

<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>

<h1 id="project_title">{{ site.title | default: site.github.repository_name }}</h1>
<h2 id="project_tagline">{{ site.description | default: site.github.project_tagline }}</h2>

{% if site.show_downloads %}
<section id="downloads">
<a class="zip_download_link" href="{{ site.github.zip_url }}">Download this project as a .zip file</a>
<a class="tar_download_link" href="{{ site.github.tar_url }}">Download this project as a tar.gz file</a>
</section>
{% endif %}
</header>
</div>

<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
{{ content }}
</section>
</div>

<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
{% if site.github.is_project_page %}
<p class="copyright">{{ site.title | default: site.github.repository_name }} maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
{% endif %}
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>

{% if site.google_analytics %}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', '{{ site.google_analytics }}', 'auto');
ga('send', 'pageview');
</script>
{% endif %}
</body>
</html>
Binary file added docs/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 17 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Home
Contents
====

[![Build Status](https://travis-ci.org/chungongyu/siga.svg?branch=master)](https://travis-ci.org/chungongyu/siga)
Expand All @@ -14,15 +14,15 @@ Home
* [Running SIGA](#running-siga)
* [Benchmarks](#benchmarks)
* [Citation](#citation)
* [Related Publications](#related-publications)
* [Publications](#publications)
* [FAQ](#faq)
* [Support](#support)
* [Authors](#authors)

Overview
========

SIGA is an open-source _de novo_ assembly toolkit containing various assembly pipelines which are totally compatible with [SGA](https://github.com/jts/sga) file format. Similar to [SGA](https://github.com/jts/sga), it is designed as a [modular set of programs](#running-siga), which are used to form an assembly pipeline.
SIGA is an open-source _de_ novo assembly toolkit containing various assembly pipelines which are totally compatible with [SGA](https://github.com/jts/sga) file format. Similar to [SGA](https://github.com/jts/sga), it is designed as a [modular set of programs](#running-siga), together which form an assembly pipeline.

Quick Start
===========
Expand All @@ -37,6 +37,8 @@ Quick Start
* [rapidjson](https://github.com/Tencent/rapidjson)
* [gperftools](https://github.com/gperftools/gperftools) (optional but suggested)

Dependencies may be installed using the package manager [Homebrew](https://homebrew.sh) on macOS and [Linxubrew](http:https://linuxbrew.sh) on Linux and Windows, using [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/).

### Compiling SIGA

If you cloned the repository from github, run `autogen.sh` from the root directory
Expand Down Expand Up @@ -134,30 +136,36 @@ siga index --help
Benchmarks
========

Comming soon...
Comming soon ...

Citation
========

## [SIGA](https://github.com/chungongyu/siga)

Chungong Yu, Yu Lin, Guozheng Wei, Bing Wang, Yanbo Li and Dongbo Bu. **SIGA** : A Sensitive and Intelligent *de* novo Genome Assembler.
Chungong Yu, Yu Lin, Guozheng Wei, Bing Wang, Yanbo Li and Dongbo Bu. **SIGA** : An open-source Sensitive and Intelligent *de* novo Genome Assembler.

Related Publications
====================
Publications
============

None yet! ^_~
None yet! ^_~

FAQ
====

1. **Where can I get further help or advice?**

See [Support](#support) or the [siga wiki](https://github.com/chungongyu/siga/wiki).
See [Support](#support) or the [siga wiki](https://github.com/chungongyu/siga/wiki).

2. **What parameters should I tune to improve my assembly?**

See [here](https://github.com/chungongyu/siga/wiki/SIGA-parameter-tuning)

Support
=======

[Create a new issue](https://github.com/chungongyu/siga/issues) on GitHub.

Contact [[email protected]](mailto:[email protected])

Authors
Expand Down

0 comments on commit 65ca637

Please sign in to comment.