Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bartekpacia committed Feb 12, 2021
1 parent 7a4244d commit 4ae2caf
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 47 deletions.
17 changes: 0 additions & 17 deletions .dockerignore

This file was deleted.

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Debug
*.o
/lidar-vis
/datasets/
/html/
/latex/

# other
*.user
Expand Down
55 changes: 25 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ Easily visualize point cloud data (e.g from LIDAR).
## Table of contents

- [Gallery](#gallery)
- [Binaries](#binaries)
- [Usage](#usage)
- [Compilation](#compilation)
- [Linux, MacOS](#linux-macos)
- [Windows (Visual Studio)](#windows-visual-studio)
- [Usage](#usage)


## Gallery

Expand All @@ -26,33 +24,6 @@ Outdoor scan (lots of trees and shrubs around)

![doc/screenshots/garden.gif](doc/screenshots/garden.gif)

## Binaries

We're still figuring out the automation process, so if you want
to run the program, you have to compile it yourself.

## Compilation

### Linux, MacOS

1. Install SFML:

```
./install_sfml
```

2. Build:

```
make
```

3. Run.

### Windows (Visual Studio)

coming soon (or never)

## Usage

After successful compilation and linking, you will have a `lidar-vis` executable.
Expand All @@ -73,3 +44,27 @@ To visualize a cloud series scan:
To learn more about all available options and keyboard shortcuts:

`$ lidar-vis --help`

## Compilation

### Linux, macOS

1. Install SFML:

`$ ./install_sfml`

2. Build:

`$ make`

3. Run:

`$ ./lidar-vis`

4. Install (Optional):

`$ make install`

### Windows (Visual Studio)

coming soon (or never)

0 comments on commit 4ae2caf

Please sign in to comment.