README.md 1.07 KB
Newer Older
Benjamin Cape's avatar
Benjamin Cape committed
1
2
# g-raph

3
4
5
6
7
8
9
10
11
> An investigation into practical and optimized implementations of graph algorithms.

## Development

This project, as of yet, uses one simple development technology `rust`.

To install rust, first ensure that you have homebrew installed. Follow instructions [here](https://brew.sh/).

Once you have homebrew, install `rust`:
Benjamin Cape's avatar
Benjamin Cape committed
12

13
14
15
16
17
18
19
20
21
22
```
> brew install rustup
> rustup-init
```

That should do it! Open the project in your text-editor of choice, and mess around! I use VS-Code, and use the [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer) extension to help with development

## Documentation

Documentation can be found [here](https://graph.host.dartmouth.edu/doc/g_raph/index.html)
Benjamin Cape's avatar
Benjamin Cape committed
23

Benjamin Cape's avatar
Benjamin Cape committed
24
25
26
27
28
29
30
31
32
33
## Testing

To run all tests, run `cargo test`.

To run specific test, either install `rust-analyzer` on VS-Code, or run the following from the root directory

```shell
> cargo test --package g-raph --lib -- graph::streaming::path-to-test --exact --nocapture
```

Benjamin Cape's avatar
Benjamin Cape committed
34
35
36
37
## Author

Benjamin Cape
Dartmouth College '22
38
39
40

Professor Amit Chakrabarti
Dartmouth College CS Department