Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update README.md to make local installation more clear #827

Merged
merged 3 commits into from
Nov 1, 2024

Conversation

thesethtruth
Copy link
Contributor

@thesethtruth thesethtruth commented Oct 31, 2024

Update README.md to make local installation more clear

AI Description

This pull request introduces changes to the README.md file, providing updated instructions for running the Toolkit application locally and in the cloud. The changes aim to enhance clarity and streamline the setup process for developers.

Changes:

  • Local Setup: The section now includes a new subsection titled "Using make", which offers an alternative method for running the application locally using a Makefile. It provides a code snippet with commands to clone the repository, navigate to the project directory, and execute the make first-run command.
  • Docker Compose: The previous "Docker Compose setup" section has been replaced with a new subsection titled "Docker Compose only". This section provides instructions for running Docker Compose directly without the Makefile, using the docker compose up command.
  • Cloud Setup: A new section titled "Cloud" has been added, offering guidance for running the project in the cloud using GitHub Codespaces. It includes a link to the "Codespaces Setup Guide" for further reference.

Copy link

cla-assistant bot commented Oct 31, 2024

CLA assistant check
All committers have signed the CLA.

@tianjing-li tianjing-li added this pull request to the merge queue Nov 1, 2024
Merged via the queue into cohere-ai:main with commit 642f2ad Nov 1, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants