koalp
865b949b5f
All checks were successful
continuous-integration/drone/pr Build is passing
A builder for mediapart have been added. No generic builder have been created as there is no usecase yet. Some documentation have been added, roadmap and scope have been clarified and chatbot have been lightly documented.
34 lines
1.0 KiB
Markdown
34 lines
1.0 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 run
|
|
|
|
```
|
|
cargo run --example=cli_downloader
|
|
```
|
|
|
|
To know how to run the chatbot, please read the [chatbot
|
|
guide](./documentation/guides/run_chatbot.md)
|
|
|
|
# Documentation
|
|
|
|
- 1. Design
|
|
- a. [Scope of the project and roadmap](./documentation/design/scope.md)
|
|
- b. [Retrieve](./documentation/design/retrieve.md)
|
|
- 2. Guides
|
|
- a. [Add a newspaper a
|
|
source](./documentation/guides/add_a_newspaper_source.md)
|
|
- 3. Reference
|
|
- a. [Newspaper source
|
|
configuration](./documentation/reference/newspaper_configuration.md)
|
|
- b. [Chatbot
|
|
configuration](./documentation/reference/chatbot_configuration.md)
|