DeCarabas/cry
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Read

Browse source
This commit is contained in:
John Doty 2024-07-11 10:34:40 +09:00
parent 6b02fb66bc
commit 21aeedd1d1
1 changed files with 1 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,41 +1,3 @@
# cry # cry
[![PyPI](https://img.shields.io/pypi/v/cry.svg)](https://pypi.org/project/cry/) A local-first, command-line feed reader. Kinda.
[![Changelog](https://img.shields.io/github/v/release/decarabas/cry?include_prereleases&label=changelog)](https://github.com/decarabas/cry/releases)
[![Tests](https://github.com/decarabas/cry/actions/workflows/test.yml/badge.svg)](https://github.com/decarabas/cry/actions/workflows/test.yml)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/decarabas/cry/blob/master/LICENSE)
Command line feed reader
## Installation
Install this tool using `pip`:
```bash
pip install cry
```
## Usage
For help, run:
```bash
cry --help
```
You can also use:
```bash
python -m cry --help
```
## Development
To contribute to this tool, first checkout the code. Then create a new virtual environment:
```bash
cd cry
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```