Restore instructions for pipx in file "README.md";
Remove instructions "tool.setuptools.packages.find" from file PyProject.
36
README.md
|
@ -27,31 +27,53 @@ Slixfeed is primarily designed for XMPP (aka Jabber), yet it is built to be exte
|
||||||
|
|
||||||
### monocles chat
|
### monocles chat
|
||||||
|
|
||||||
<img alt="Chat: Add URL" src="screenshots/chat_add_url.png" width="200px"/>
|
<img alt="Chat: Add URL" src="slixfeed/documentation/screenshots/chat_add_url.png" width="200px"/>
|
||||||
<img alt="Ad-Hoc: Commands" src="screenshots/adhoc_commands.png" width="200px"/>
|
<img alt="Ad-Hoc: Commands" src="slixfeed/documentation/screenshots/adhoc_commands.png" width="200px"/>
|
||||||
|
|
||||||
<!-- ![Chat: Add URL](screenshots/chat_add_url.png) ![Ad-Hoc: Commands](screenshots/adhoc_commands.png) -->
|
<!-- ![Chat: Add URL](slixfeed/documentation/screenshots/chat_add_url.png) ![Ad-Hoc: Commands](slixfeed/documentation/screenshots/adhoc_commands.png) -->
|
||||||
|
|
||||||
### Cheogram
|
### Cheogram
|
||||||
|
|
||||||
<img alt="Ad-Hoc: Add URL" src="screenshots/adhoc_add_url.png" width="200px"/>
|
<img alt="Ad-Hoc: Add URL" src="slixfeed/documentation/screenshots/adhoc_add_url.png" width="200px"/>
|
||||||
<img alt="Ad-Hoc: Settings" width="200px" src="screenshots/adhoc_settings.png"/>
|
<img alt="Ad-Hoc: Settings" width="200px" src="slixfeed/documentation/screenshots/adhoc_settings.png"/>
|
||||||
|
|
||||||
<!-- ![Ad-Hoc: Add URL](screenshots/adhoc_add_url.png) ![Ad-Hoc: Preview URL](screenshots/adhoc_preview_url.png) ![Ad-Hoc: Settings](screenshots/adhoc_settings.png) -->
|
<!-- ![Ad-Hoc: Add URL](slixfeed/documentation/screenshots/adhoc_add_url.png) ![Ad-Hoc: Preview URL](slixfeed/documentation/screenshots/adhoc_preview_url.png) ![Ad-Hoc: Settings](slixfeed/documentation/screenshots/adhoc_settings.png) -->
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Install
|
### Install
|
||||||
|
|
||||||
It is possible to install Slixfeed using pip inside venv.
|
It is possible to install Slixfeed using pip and pipx.
|
||||||
|
|
||||||
|
#### pip inside venv
|
||||||
|
|
||||||
```
|
```
|
||||||
$ python3 -m venv .venv
|
$ python3 -m venv .venv
|
||||||
$ source .venv/bin/activate
|
$ source .venv/bin/activate
|
||||||
$ pip install git+https://gitgud.io/sjehuda/slixfeed
|
$ pip install git+https://gitgud.io/sjehuda/slixfeed
|
||||||
|
```
|
||||||
|
|
||||||
|
#### pipx
|
||||||
|
|
||||||
|
##### Install
|
||||||
|
|
||||||
|
```
|
||||||
|
$ pipx install git+https://gitgud.io/sjehuda/slixfeed
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Upgrade
|
||||||
|
|
||||||
|
```
|
||||||
|
$ pipx install --upgrade slixfeed
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Start
|
||||||
|
|
||||||
|
```
|
||||||
$ slixfeed
|
$ slixfeed
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
- Add the bot to contact list and follow it instructions.
|
- Add the bot to contact list and follow it instructions.
|
||||||
|
|
|
@ -86,9 +86,3 @@ platforms = ["any"]
|
||||||
|
|
||||||
[tool.setuptools.package-data]
|
[tool.setuptools.package-data]
|
||||||
"*" = ["*.ini", "*.csv", "*.toml", "*.svg"]
|
"*" = ["*.ini", "*.csv", "*.toml", "*.svg"]
|
||||||
|
|
||||||
[tool.setuptools.packages.find]
|
|
||||||
where = ["."]
|
|
||||||
include = ["slixfeed"]
|
|
||||||
exclude = []
|
|
||||||
namespaces = false
|
|
||||||
|
|
Before Width: | Height: | Size: 202 KiB After Width: | Height: | Size: 202 KiB |
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
Before Width: | Height: | Size: 183 KiB After Width: | Height: | Size: 183 KiB |