Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nzfeng committed Feb 2, 2021
1 parent 88be0ac commit 919c88f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ cd ddg-exercises/projects
```

Each project in `ddg-exercises/projects` builds its own executable when compiled. To
run a particular project `<project>`, go to the `projects/<project>` directory. The basic process for compiling is as follows. First, compile using
run a particular project `<project>`, go to the `projects/<project>` directory. The basic process for compiling is as follows. First, make a `build` directory and compile using
```
mkdir build
cd build
cmake ..
make
```
which builds an executable `main` which can then be run using
This builds an executable `main` which can then be run using
```
bin/main <optional_path_to_a_mesh>
```

(See https://geometry-central.net/build/building/ for additional compiler flag options.)
(See [Geometry Central: Building](https://geometry-central.net/build/building/) for additional compiler flag options.

## Dependencies (all included)

Expand All @@ -48,6 +48,12 @@ Nicole Feng

Email: nfeng@cs.cmu.edu

Rohan Sawhney (original JavaScript version)

Email: rohansawhney@cs.cmu.edu

This code is directly based off Rohan's original JavaScript framework, [ddg-exercises-js](https://github.com/cmu-geometry/ddg-exercises-js).

## License

[MIT](https://opensource.org/licenses/MIT)

0 comments on commit 919c88f

Please sign in to comment.