Skip to content

Commit

Permalink
make slight changes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Eisenwave committed Aug 10, 2023
1 parent f3f1e28 commit ee8712d
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This repository contains the source code for the Wheatley bot, made for the Together C & C++ discord server.

## Code organization
## Project Structure

- `indexes/` Code for processing cppreference and man7 data to create a searchable index
- `src/` Main source code for the bot
Expand All @@ -29,12 +29,15 @@ Secrets and other bot info must be configured in the bot.json file. An example l
"guild": "<guild id>",
"token": "<discord api token>",
"mongouser": "wheatley",
"mongopassword": "<mongo password>"
"mongopassword": "<mongo password>",
"freestanding": false
}
```

Mongo credentials can be omitted locally if you don't need to work on components that use mongo. `freestanding: true`
can be specified to turn on only components which don't rely on channels etc. specific to Together C & C++ to exist.
Mongo credentials can be omitted locally if you don't need to work on components
that use mongo.
`freestanding: true` can be specified to turn on only components which don't
rely on channels etc. specific to Together C & C++ to exist.

## Database

Expand Down

0 comments on commit ee8712d

Please sign in to comment.