dnhkng / GlaDOS

This is the Personality Core for GLaDOS, the first steps towards a real-life implementation of the AI from the Portal series by Valve.
MIT License
3.04k stars 285 forks source link

Adding macOS installation instructions in README #70

Closed Ghostboo-124 closed 5 months ago

Ghostboo-124 commented 5 months ago

Adding the installation instructions for macOS into the README

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

[!WARNING]

Rate limit exceeded

@Ghostboo-124 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 13 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 8de820db265896df586a9e13ad54639a51887e51 and 2bd57063e1ebcd01399f57a05925e272e5f09ec5.

Walkthrough

The README.md has been updated to include a new section that details an experimental installation process for GLaDOS on macOS. This process involves installing Python 3.12, potentially using Homebrew, cloning the repository, and running specific scripts for installation and starting GLaDOS. No modifications were made to the declarations of exported or public entities.

Changes

File Change Summary
README.md Added a new section for the experimental macOS installation process

Poem

🍏🔧 In the land of code and bytes,
GLaDOS gets a macOS flight.
Python brews and scripts do run,
An experimental dance has begun.
Clone the repo, start the flow,
On your Mac, let GLaDOS glow. 🚀✨


[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
coderabbitai[bot] commented 5 months ago

[!TIP] For best results, initiate chat on the files or code changes.

@Ghostboo-124, here are the interesting statistics about the repository, rendered as a table:

Statistic Count
Authors 2
Lines of Code 3722
TODO Comments 1
Files 65
Commits 3
Branches 2
Pull Requests 28
Issues 30

If you need any further details or additional statistics, please let me know!

Analysis chain --- --- ---
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Count the number of authors in the codebase. authors=$(git shortlog -sn --all | wc -l) # Count the total number of lines of code in the codebase. lines_of_code=$(tokei --output json | jq '.total.lines') # Count the number of `TODO` comments in the codebase. todos=$(rg -c "TODO" | wc -l) # Count the number of files in the codebase. files=$(find . -type f | wc -l) # Count the number of commits in the codebase. commits=$(git rev-list --all --count) # Count the number of branches in the repository. branches=$(git branch -r | wc -l) # Count the number of pull requests in the repository. pull_requests=$(gh pr list --state all | wc -l) # Count the number of issues in the repository. issues=$(gh issue list --state all | wc -l) # Print the gathered statistics as a table. echo -e "Statistic\t\tCount" echo -e "---------\t\t-----" echo -e "Authors\t\t\t$authors" echo -e "Lines of Code\t\t$lines_of_code" echo -e "TODO Comments\t\t$todos" echo -e "Files\t\t\t$files" echo -e "Commits\t\t\t$commits" echo -e "Branches\t\t$branches" echo -e "Pull Requests\t\t$pull_requests" echo -e "Issues\t\t\t$issues" ``` Length of output: 805 --- --- Script: ```shell #!/bin/bash # Count the number of authors in the codebase. authors=$(git shortlog -sn --all | wc -l) # Count the total number of lines of code in the codebase. lines_of_code=$(tokei --output json | jq '.inner.total.lines') # Count the number of `TODO` comments in the codebase. todos=$(rg -c "TODO" | wc -l) # Count the number of files in the codebase. files=$(find . -type f | wc -l) # Count the number of commits in the codebase. commits=$(git rev-list --all --count) # Count the number of branches in the repository. branches=$(git branch -r | wc -l) # Count the number of pull requests in the repository. pull_requests=$(gh pr list --state all | wc -l) # Count the number of issues in the repository. issues=$(gh issue list --state all | wc -l) # Print the gathered statistics as a table. echo -e "Statistic\t\tCount" echo -e "---------\t\t-----" echo -e "Authors\t\t\t$authors" echo -e "Lines of Code\t\t$lines_of_code" echo -e "TODO Comments\t\t$todos" echo -e "Files\t\t\t$files" echo -e "Commits\t\t\t$commits" echo -e "Branches\t\t$branches" echo -e "Pull Requests\t\t$pull_requests" echo -e "Issues\t\t\t$issues" ``` Length of output: 811 --- --- Script: ```shell #!/bin/bash # Extract the JSON output from tokei and inspect its structure. tokei --output json ``` Length of output: 5628 --- --- Script: ```shell #!/bin/bash # Count the number of authors in the codebase. authors=$(git shortlog -sn --all | wc -l) # Count the total number of lines of code in the codebase. lines_of_code=$(tokei --output json | jq '.Total.code') # Count the number of `TODO` comments in the codebase. todos=$(rg -c "TODO" | wc -l) # Count the number of files in the codebase. files=$(find . -type f | wc -l) # Count the number of commits in the codebase. commits=$(git rev-list --all --count) # Count the number of branches in the repository. branches=$(git branch -r | wc -l) # Count the number of pull requests in the repository. pull_requests=$(gh pr list --state all | wc -l) # Count the number of issues in the repository. issues=$(gh issue list --state all | wc -l) # Print the gathered statistics as a table. echo -e "Statistic\t\tCount" echo -e "---------\t\t-----" echo -e "Authors\t\t\t$authors" echo -e "Lines of Code\t\t$lines_of_code" echo -e "TODO Comments\t\t$todos" echo -e "Files\t\t\t$files" echo -e "Commits\t\t\t$commits" echo -e "Branches\t\t$branches" echo -e "Pull Requests\t\t$pull_requests" echo -e "Issues\t\t\t$issues" ``` Length of output: 804