Skip to content

Commit

Permalink
updated readme and makegadgets for ros2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
akoerner1 committed Dec 5, 2024
1 parent 3ff31c6 commit 3f35f7b
Show file tree
Hide file tree
Showing 11 changed files with 13 additions and 131 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ adore_cli
.ccache
adore_cli_core
**/.tmp
.tmp
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# ADORe CLI
The adore_cli project provides a runtime docker context for ADORe.
The ADORe CLI project provides a ROS2 context and runtime context for ADORe.

## Getting started
## Prerequisites
Docker and make must be installed to use this project

## Getting started

1. clone the repository
2. run the provided make target to launch the cli
```bash
Expand Down
22 changes: 7 additions & 15 deletions adore_cli.mk
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ SHELL:=/bin/bash
ADORE_CLI_PROJECT:=adore_cli_core
ADORE_CLI_MAKEFILE_PATH:=$(shell realpath "$(shell dirname "$(lastword $(MAKEFILE_LIST))")")

ifeq ($(SUBMODULES_PATH),)
ADORE_CLI_SUBMODULES_PATH:=${ADORE_CLI_MAKEFILE_PATH}
else
ADORE_CLI_SUBMODULES_PATH:=$(shell realpath ${SUBMODULES_PATH})
endif
ADORE_CLI_SUBMODULES_PATH:=${ADORE_CLI_MAKEFILE_PATH}

MAKE_GADGETS_PATH:=${ADORE_CLI_SUBMODULES_PATH}/make_gadgets
ifeq ($(wildcard $(MAKE_GADGETS_PATH)/*),)
Expand Down Expand Up @@ -56,28 +52,24 @@ $(shell touch "${ADORE_CLI_MAKEFILE_PATH}/.bash_history")
$(shell mkdir -p "${SOURCE_DIRECTORY}/.log")

.PHONY: start
start: adore_cli_setup adore_cli_start adore_cli_attach adore_cli_teardown ## OFFLINE start of adore cli

.PHONY: run
run: adore_cli_setup adore_cli_start adore_cli_run adore_cli_teardown ## Execute a command in the ADORe CLI context `make run cmd="<command to execute>"`
start: adore_cli_setup adore_cli_start ## Start the ADORe CLI docker compose context

.PHONY: stop
stop: stop_adore_cli
stop: stop_adore_cli ## Stop ADORe CLI docker compose context if it is running

.PHONY: run
run: adore_cli_setup adore_cli_start adore_cli_run adore_cli_teardown ## Execute a command in the ADORe CLI context `make run cmd="<command to execute>"`
.PHONY: adore_cli_up
adore_cli_up: adore_cli_setup adore_cli_start adore_cli_attach adore_cli_teardown

.PHONY: cli
cli: adore_cli ## Same as 'make adore_cli' for the lazy

.PHONY: stop_adore_cli
stop_adore_cli: docker_host_context_check adore_cli_teardown ## Stop adore_cli docker context if it is running

.PHONY: stop_adore_cli
stop_adore_cli: docker_host_context_check adore_cli_teardown

.PHONY: adore_cli
adore_cli: docker_host_context_check ## Start adore_cli context or attach to it if already running
.PHONY: cli
cli: docker_host_context_check ## Start ADORe CLI docker context or attach to it if it is already running
@if [[ "$$(docker inspect -f '{{.State.Running}}' '${ADORE_CLI_CONTAINER_NAME}' 2>/dev/null)" == "true" ]]; then\
cd "${ADORE_CLI_MAKEFILE_PATH}" && make --file=${ADORE_CLI_MAKEFILE_PATH}/adore_cli.mk adore_cli_attach;\
exit 0;\
Expand Down
37 changes: 0 additions & 37 deletions adore_cli/.tmp/Makefile

This file was deleted.

Binary file removed adore_cli/.tmp/packages/casadi_20241128-1_amd64.deb
Binary file not shown.
Binary file removed adore_cli/.tmp/packages/eigen3_20230705-1_amd64.deb
Binary file not shown.
Binary file removed adore_cli/.tmp/packages/optinlc_0.1.1_amd64.deb
Binary file not shown.
Binary file removed adore_cli/.tmp/packages/osqp_20230705-1_amd64.deb
Binary file not shown.
9 changes: 0 additions & 9 deletions adore_cli/.tmp/requirements/combined_requirements.pip3

This file was deleted.

67 changes: 0 additions & 67 deletions adore_cli/.tmp/requirements/combined_requirements.system

This file was deleted.

2 changes: 1 addition & 1 deletion make_gadgets

0 comments on commit 3f35f7b

Please sign in to comment.