Skip to content

Commit

Permalink
add docs to readme and only build docs on doc change
Browse files Browse the repository at this point in the history
  • Loading branch information
SeppeDeWinter authored Feb 1, 2024
1 parent f1477d1 commit c66f508
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ on:
push:
branches:
- "main"
#paths:
#-"docs/**"
paths:
-"docs/**"

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# scATAC Fragment Tools

Tools for working with scATAC-seq fragment files.

## Installation

git clone https://github.com/aertslab/scatac_fragment_tools.git
cd scatac_fragment_tools
pip install .

## Usage

Please visit the [documentation](https://chrisholdgraf.com/blog/2022/install-github-from-pyproject/)

0 comments on commit c66f508

Please sign in to comment.