Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: README #5

Merged
merged 2 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ Please describe the tests that you ran to verify your changes. Provide instructi
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] I have checked my code and documentation and corrected any misspellings
- [ ] Usage Documentation in [USAGE.md](../USAGE.md) is updated
- [ ] Usage Documentation is updated
- [ ] If you are doing a [release](../RELEASING.md#Releasing), or a significant change to the code, update [CHANGELOG.md](../CHANGELOG.md)
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ and can be used as a python library for further downstream processing.

## Documentation

More information about pixelator is available on the [Pixelgen Techologies documentation site](https://software.pixelgen.com/).
More information about pixelator is available on the [Pixelgen Techologies Software documentation site](https://software.pixelgen.com/).

## Installation

### Installation with pip

pixelator is available on pypi as `pixelgen-pixelator` and can be installed with pip.
Our software pixelator is available on pypi as `pixelgen-pixelator` and can be installed with pip.
It is recommended to install pixelator in a separate virtual environment.

```shell
Expand All @@ -59,7 +59,7 @@ mamba install -c bioconda pixelator

### Installation from source

Pixelator can be installed from source by cloning the repository.
You can also install pixelator from source by cloning the repository.

```shell
git clone https://github.com/pixelgentechnologies/pixelator.git
Expand All @@ -69,7 +69,7 @@ pip install .

### Using docker

The pixelator commandline tool can be run with docker images available on
The `pixelator`` command-line tool can be run with docker images available on
the [GitHub container registry](https://github.com/PixelgenTechnologies/pixelator/pkgs/container/pixelator).

```shell
Expand All @@ -84,8 +84,8 @@ Please check out the [contributing guidelines](./CONTRIBUTING.md) for more infor

## Contact

For feature requests or bug reports, please use the GitHub issues.
For questions, comments, or suggestions you can use the GitHub discussions.
For feature requests or bug reports, please use the GitHub [issues](https://github.com/PixelgenTechnologies/pixelator/issues).
For questions, comments, or suggestions you can use the GitHub [discussions](https://github.com/PixelgenTechnologies/pixelator/discussions).

You can also email the development team at [developers@pixelgen.com](mailto:developers@pixelgen.com).

Expand Down
313 changes: 0 additions & 313 deletions USAGE.md

This file was deleted.