Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Conversation

@irfanpena
Copy link
Contributor

Describe Your Changes

  • Draft the Platform readme

Fixes Issues

  • Closes #
  • Closes #

Self Checklist

  • Added relevant comments, esp in complex areas
  • Updated docs (for bug fixes / features)
  • Created issues for follow-up changes or refactoring needed

@irfanpena irfanpena self-assigned this Sep 5, 2024
@irfanpena
Copy link
Contributor Author

#1036

@dan-menlo dan-menlo changed the title Draft the Cortex Platform readme Simplify Cortex README.md Sep 9, 2024
@freelerobot
Copy link
Contributor

@irfanpena would you mind resolving the comments you fixed so that we can lgtm? 🙏

@irfanpena
Copy link
Contributor Author

@irfanpena would you mind resolving the comments you fixed so that we can lgtm? 🙏

@0xSage I have resolved the comment that I fixed; the rest I have updated, but I need your review, for example:

  1. I am not really sure whether to use Cortex or CortexCPP- > based on this: Cortex.cpp: Data Structures #1115 (comment) the finalized name is CortexCPP, so I used CortexCPP in the readme.

  2. Also for the installation section, as now we use native installers, I have updated the readme to redirect to the download links for each respective installer based on the different operating systems:

Installation

To install CortexCPP, download the installer for your operating system from the following options:

## REST API
Cortex has a REST API that runs at `localhost:1337`.
Cortex.cpp has a REST API that runs at `localhost:3928`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check with @vansangpfiev @namchuai: There is a chance we will change the port number to something less collision-prone (i.e. more digits?)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's bring this into discussion. I'm ok with any port number decision.

@dan-menlo
Copy link
Contributor

@irfanpena I've left a few requests for change - otherwise, thank you for drafting this

Copy link
Contributor

@dan-menlo dan-menlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@irfanpena Thanks - you can go ahead to merge this first

@dan-menlo dan-menlo merged commit bf0434b into dev Sep 12, 2024
@dan-menlo dan-menlo deleted the platform-readme branch September 12, 2024 09:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants