update packard article to match github readme (#26)
This commit is contained in:
parent
62d33d702c
commit
1174e6462e
3 changed files with 50 additions and 2 deletions
BIN
src/content/projects/packard/demo.gif
Normal file
BIN
src/content/projects/packard/demo.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 1 MiB |
|
@ -6,13 +6,61 @@ updated: 2025-01-12
|
|||
image:
|
||||
{
|
||||
url: "packard.avif",
|
||||
alt: "Packard GitHub repository page",
|
||||
alt: "Packard GitHub v0.0.1 Release",
|
||||
}
|
||||
tags: ["rust", "rss aggregator"]
|
||||
categories: ["personal"]
|
||||
---
|
||||
|
||||
Packard is a simple RSS aggregator meant to allow you to take a quick glance at what's occurring in topics you care about. It is my first attempt at making something with Rust that I would personally find useful.
|
||||

|
||||
|
||||
Packard is a simple RSS aggregator meant to allow you to take a quick glance at what's occurring in topics you care about. This is my first attempt at making something with Rust so that I may learn alongside creating something that I personally find useful.
|
||||
|
||||

|
||||
|
||||
## Configuration
|
||||
|
||||
There are now several options available to be configured, with more on their way. As of now Packard's config file should be placed within `$HOME/.config/packard` and formatted in TOML.
|
||||
|
||||
1. `count`
|
||||
|
||||
This can be adjusted either by using the `-c` flag when running the program, or by setting it in the config. Note that if `count` is set within the config file and then the program is run with the `-c` flag, this flag will overwrite the config file. Unlike other options, there is a default value for `count` which is set to 8.
|
||||
|
||||
2. `skip_amount`
|
||||
|
||||
If you wish to view older articles without having to scroll through newer ones to get there, use `-s` or the `skip_amount` option to do that. This will skip the amount specified whilst still returning your specified `count` amount of articles. By default this option is set to 0.
|
||||
|
||||
3. `selected_list`
|
||||
|
||||
Using the configured lists mentioned above, this option selects which of those you want to see. This can be set using the `selected_list` option in the config or by running the program using the `-l` flag. Again, using the flag will overwrite the option if it is specified in the config.
|
||||
|
||||
4. `[lists]`
|
||||
|
||||
Lists can be configured in Packard so that they can be easily swapped out depending on what you want to see. Please see the example config for reference.
|
||||
|
||||
### Example config.toml
|
||||
|
||||
```toml
|
||||
count = 8
|
||||
#skip_amount = 4
|
||||
selected_list = "personal"
|
||||
|
||||
[lists]
|
||||
personal = [
|
||||
"https://troylusty.com/rss.xml",
|
||||
"https://mitchellh.com/feed.xml"
|
||||
]
|
||||
news = [
|
||||
"https://www.gamingonlinux.com/article_rss.php?newsonly",
|
||||
"https://store.steampowered.com/feeds/news.xml",
|
||||
]
|
||||
```
|
||||
|
||||
## Interaction
|
||||
|
||||
After running Packard with your configured settings, the parsed results can be opened in your default browser however your terminal allows for opening URLs. For example the keybind for this with [Foot](https://codeberg.org/dnkl/foot#urls) is `ctrl` + `shift` + `o`.
|
||||
|
||||
Currently no keyboard interaction is implemented. To get around this you can pipe the output of Packard into a tool like `less` like so: `packard -c 12 -l news -s 3 | less`. Be aware, this will remove any text formatting that has been applied.
|
||||
|
||||
### External links
|
||||
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 6.6 KiB |
Loading…
Add table
Reference in a new issue