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.

Sign up for GitHub

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

update readme #8

Merged
merged 1 commit into from
Dec 7, 2023
Merged

update readme #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,19 @@

These plugins extend TuiView functionality. Mainly as an example of how to build plugins, but hopefully do a few useful things also.

Instructions on how to install them are to be found in the "Installing Plugin File" section of the [TuiView Plugins Documentation](https://github.com/ubarsc/tuiview/wiki/Plugins).

Update:
This package can now be installed with 'python setup.py install'. Then run: tuiviewpluginmgr
This package can be used in 3 different ways:

1. Clone repo and copy files or set the `TUIVIEW_PLUGINS_PATH` env var to the location of the individual plugin directions as
specified here in the [TuiView Plugins Documentation](https://github.com/ubarsc/tuiview/wiki/Plugins#installing-plugin-file).
Useful for development.

2. Clone repo and run `pip install .` to install all plugins and use the `tuiviewpluginmgr` GUI application (below)
to:
a) determine which plugin(s) you wish to have active and,
b) how to set the `TUIVIEW_PLUGINS_PATH` env var to make this happen for your system.

![tuiviewpluginmgr](pluginmgr.png)

3. Clone repo and run `pip install .` to install all plugins and import the particular one you want into your Python script
to use when [scripting TuiView](https://github.com/ubarsc/tuiview/wiki/Saving-Images-From-Python).
Binary file added pluginmgr.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading