Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Asudox authored Jan 17, 2024
1 parent 55ebc60 commit 3aa92f9
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 1,7 @@
# lemmy-wikibot-rs
A lemmy bot written in Rust to summarize wikipedia articles and reply to them.

# How to run locally
## How to run locally
1. Clone the repository: `git clone https://github.com/Asudox/lemmy-wikibot-rs.git`
- Install Rust if you haven't yet: https://www.rust-lang.org/tools/install

Expand All @@ -18,8 19,11 @@ A lemmy bot written in Rust to summarize wikipedia articles and reply to them.
5. Run the bot: `cargo run --release`


# TODO
## TODO
- [ ] Multiple wikipedia link support
- [ ] Better error handling (?)
- [x] Opt-out functionality
- [ ] Fix wikipedia section support

## License
This project is licensed under the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html).

0 comments on commit 3aa92f9

Please sign in to comment.