koalp
48485c3097
An image to run crieur-chatbot have been added. The crieur-chatbot matrix-sdk dependency have been edited in order to use rustls instead of native tsl library.
41 lines
1.2 KiB
Markdown
41 lines
1.2 KiB
Markdown
Tools to retrieve articles from multiple newspaper you subscribed to.
|
|
|
|
**This is a prototype, it isn't stable at all and you may not want to use it if
|
|
you expect it to just work !**
|
|
|
|
# How to use it
|
|
|
|
First retrieve login cookies for websites and put it in a `.env` such as
|
|
explained in the [newspaper source configuration
|
|
documentation](./documentation/reference/newspaper_configuration.md)
|
|
|
|
Then you can run [an example](./examples/cli_downloader.rs) using
|
|
|
|
```
|
|
cargo run --example=cli_downloader
|
|
```
|
|
|
|
You can also specify the URL using
|
|
```
|
|
cargo run --example=cli_downloader -- [your url]
|
|
```
|
|
|
|
To know how to run the chatbot, please read the [chatbot
|
|
guide](./documentation/guides/run_chatbot.md)
|
|
|
|
# Documentation
|
|
|
|
1. Design
|
|
1. [Scope of the project and roadmap](./documentation/design/scope.md)
|
|
2. [Retrieve](./documentation/design/retrieve.md)
|
|
3. [Tooling](./documentation/design/tooling.md)
|
|
2. Guides
|
|
1. [Add a newspaper a source
|
|
](./documentation/guides/add_a_newspaper_source.md)
|
|
2. [Build and run the chatbot](./documentation/guides/run_chatbot.md)
|
|
3. Reference
|
|
1. [Newspaper source
|
|
configuration](./documentation/reference/newspaper_configuration.md)
|
|
2. [Chatbot
|
|
configuration](./documentation/reference/chatbot_configuration.md)
|