Skip to content

Commit

Permalink
RSDK-2012 & RSDK-2013 - Remove slam libraries (viamrobotics#164)
Browse files Browse the repository at this point in the history
  • Loading branch information
zaporter-work authored Mar 7, 2023
1 parent 8aac0bc commit 0acfd71
Show file tree
Hide file tree
Showing 75 changed files with 5 additions and 8,590 deletions.
8 changes: 2 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,8 @@
*.DS_Store
*.swp

# generate folders
grpc/
# Generated directories
bin/

# code editor settings
# Code editor settings
.vscode

# grpc
slam-libraries/grpc
6 changes: 0 additions & 6 deletions .gitmodules

This file was deleted.

1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ tool-install:
github.com/rhysd/actionlint/cmd/actionlint

lint-go: tool-install
go mod tidy
go vet -vettool=$(TOOL_BIN)/combined ./...
GOGC=50 $(TOOL_BIN)/golangci-lint run -v --fix --config=./etc/.golangci.yaml

Expand Down
64 changes: 2 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,11 @@
# SLAM
# SLAM Utils

## (In)stability Notice
> **Warning**
> This is an experimental feature. Stability is not guaranteed. Breaking changes are likely to occur, and occur often.
## Overview
This repo contains [SLAM libraries](https://github.com/viamrobotics/slam/tree/main/slam-libraries) that are integrated within Viam's [RDK](https://github.com/viamrobotics/rdk).

## Getting started

### Download and install
```bash
git clone --recurse-submodules git@github.com:viamrobotics/slam.git
```

If you happened to use `git clone` only, you won't see the libraries in the `slam-libraries` folder and will need to fetch them:

`git submodule update --init`

### Running the SLAM libraries
[slam-libraries](./slam-libraries) contains currently supported SLAM implementations. To get started with setting up and running the SLAM libraries, follow the instructions on the [slam-libraries README](./slam-libraries/README.md).

## Development
### Linting

```bash
brew install clang-format
make format
```

### Working with submodules

#### Clone and pull

1. Clone repo: `git clone --recurse-submodules git@github.com:viamrobotics/slam.git`
2. `cd slam`
* If you forgot `--recurse-submodules` when cloning or can't find any code in the gitmodules folders, run this: `git submodule update --init`
2. `git checkout YOUR_SLAM_BRANCH`
3. Make sure your submodules are also on the correct branch by running `git submodule update --init`

#### Commit and push
1. Commit and push changes in the submodules first.
2. Commit and push changes in the `slam` library last.

Or, alternatively:
1. Commit changes in the submodules
1. Commit changes in the main repo
1. Push all changes by running `git push --recurse-submodules=on-demand`

#### Changing branches in a submodule
When changing branches in a submodule, update `.gitmodules`, e.g., changing to a branch called `kk/fix-install`:

```bash
...
[submodule "slam-libraries/cartographer"]
path = slam-libraries/cartographer
url = git@github.com:kkufieta/cartographer.git
branch=kk/fix-install
```

Commit & push the changes.

When pulling those changes, run the following:
```bash
git pull
git submodule update --init --recursive
```
This repo contains utils for implementing a [slam service](https://github.com/viamrobotics/rdk/blob/main/services/slam/slam.go) in Golang.

## License
Copyright 2022 Viam Inc.
Expand Down
105 changes: 0 additions & 105 deletions slam-libraries/Makefile

This file was deleted.

67 changes: 0 additions & 67 deletions slam-libraries/README.md

This file was deleted.

4 changes: 0 additions & 4 deletions slam-libraries/buf.gen.yaml

This file was deleted.

4 changes: 0 additions & 4 deletions slam-libraries/buf.grpc.gen.yaml

This file was deleted.

Loading

0 comments on commit 0acfd71

Please sign in to comment.