Skip to content

Commit

Permalink
docs: added an xcode page for osx (#1030)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaskowicz1 authored Dec 4, 2023
1 parent 4da4f45 commit d13287d
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/docs_change_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Documentation change checklist

- [ ] My documentation changes follow the [docs style guide](https://dpp.dev/docs_standards.html) and any code examples follow the [coding style guide](https://dpp.dev/coding-standards.html).
- [ ] My documentation changes follow the [docs style guide](https://dpp.dev/docs-standards.html) and any code examples follow the [coding style guide](https://dpp.dev/coding-standards.html).
- [ ] I tested that my change works before raising the PR (via running `doxygen`, and testing examples).
- [ ] I have not moved any existing pages or changed any existing URLs without strong justification as to why.
- [ ] I have not generated content using AI or a desktop utility such as grammarly.
1 change: 1 addition & 0 deletions docpages/04_building_a_bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Click on a link below for a guide specifically for your system:
* \subpage buildcmake
* \subpage buildmeson
* \subpage building-a-cpp-discord-bot-in-repl
* \subpage build-a-bot-xcode
Binary file added docpages/images/xcode_output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docpages/images/xcode_run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docpages/images/xcode_token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docpages/make_a_bot/xcode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
\page build-a-bot-xcode Building a Discord Bot using Xcode (OSX)

\warning This tutorial expects you to have installed D++ via homebrew. If you haven't, please visit \ref install-brew.

To create a bot with Xcode, follow the steps below to create a *working skeleton project you can build upon*.

\note Since the brew package for D++ only supports C++17, you can't use coro with this project. If you wish to use coro, you need to \ref buildosx "build from source". If you do build from source, look to replace the include and library paths in this project to `/usr/local/include` and `/usr/local/lib`.

1. Make sure you have Xcode downloaded, along with the developer command tools (for AppleClang).
2. Clone the [template project](https://github.com/Jaskowicz1/mac-bot-template/). **Make sure you download the entire project and not just the .cpp file.**
3. Open Xcode, hit "Open Existing Project" or "File"->"Open", navigate to the template folder and open the .xcodeproj file. You can also double click the file in Finder.
4. Replace "add your token here" with your bot's token in the "main" file.
\image html xcode_token.png
5. Click the run button to compile and run your bot!
\image html xcode_run.png
6. Observe the output and watch your bot run! You may get warnings in this stage and that's okay!
\image html xcode_output.png

## Troubleshooting

- Stuck? You can find us on the [official Discord server](https://discord.gg/dpp) - ask away! We don't bite!

0 comments on commit d13287d

Please sign in to comment.