Move stuff over from previous incarnation into new frame
Thanks to Simon Wilson for the layout
This commit is contained in:
commit
6be6afdbc3
15 changed files with 799 additions and 0 deletions
41
README.md
Normal file
41
README.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# cry
|
||||
|
||||
[](https://pypi.org/project/cry/)
|
||||
[](https://github.com/decarabas/cry/releases)
|
||||
[](https://github.com/decarabas/cry/actions/workflows/test.yml)
|
||||
[](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
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue