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

Cocos-91 - Update Makefile and cocos documentation #93

Merged
merged 13 commits into from
Apr 8, 2024

Conversation

smithjilks
Copy link
Contributor

@smithjilks smithjilks commented Mar 8, 2024

Updated Makefile to include install instructions for manager.

Updated manager/README.md and cli/README.md to reflect changes in the Makefile.

Resolves #91

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@drasko
Copy link
Contributor

drasko commented Mar 14, 2024

No need for automated installation for now. We can keep CLI in the build dir. This cli will be published on our GitHub on our GitHub, compiled statically and downloadable from GitHub - so no installation will be done via Makefile.

@drasko
Copy link
Contributor

drasko commented Mar 14, 2024

Just remove instructions for installation of the CLI, and use it directly from ./build dir.

Makefile Outdated
@@ -1,12 +1,12 @@
BUILD_DIR = build
INSTALL_DIR = /usr/bin
Copy link
Contributor

Choose a reason for hiding this comment

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

Do not install

Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove INSTALL_DIR and do not resolve comments and remarks yourself.

manager/README.md Show resolved Hide resolved
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Makefile Outdated
@@ -1,12 +1,12 @@
BUILD_DIR = build
INSTALL_DIR = /usr/bin
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove INSTALL_DIR and do not resolve comments and remarks yourself.

cli/README.md Outdated
@@ -7,7 +7,7 @@ This repository contains the command-line interface (CLI) tool for interacting w
From the project root:

```bash
make cli
make
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not correct - it should be make cli

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has been updated


# compile the manager
make manager
Copy link
Contributor

Choose a reason for hiding this comment

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

We should be capable to make Manager with make manager

Copy link
Contributor Author

@smithjilks smithjilks Mar 20, 2024

Choose a reason for hiding this comment

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

This has been updated

Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Signed-off-by: Jilks Smith <smithjilks@gmail.com>

cd $GOPATH/src/github.com/ultravioletrs/cocos
cd cocos

# compile the manager
Copy link
Contributor

Choose a reason for hiding this comment

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

Capitalize comments (Compile the Manager)

@@ -142,16 +142,13 @@ To start the service, execute the following shell script (note a server needs to

```bash
# download the latest version of the service
Copy link
Contributor

Choose a reason for hiding this comment

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

Capitalize the comment (Download the latest version of the service)

Signed-off-by: Jilks Smith <smithjilks@gmail.com>
Copy link
Contributor

@drasko drasko left a comment

Choose a reason for hiding this comment

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

LGTM

@drasko drasko merged commit b6f1164 into ultravioletrs:main Apr 8, 2024
1 check 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.

Update makefile and manager documentation
3 participants