Skip to content

Commit 1087ebf

Browse files
committed
update readme
1 parent 18f8362 commit 1087ebf

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Digraph
2+
Simple program that lets you find paths of specified length in huge graphs.
3+
## Requirements
4+
- Linux or Windows
5+
- Processor capable of executing AVX2 instructions (most of modern processors support it, thus you shouldn't be concerned)
6+
7+
> [!IMPORTANT]
8+
> Windows machines must have [Visual C++ Runtime](https://aka.ms/vc14/vc_redist.x64.exe) installed.
9+
210
## Usage
11+
> [!NOTE]
12+
> You might also drag and drop the description file onto the executable to run it.
313
### Windows
414
```
515
digraph.exe {graph_path}
@@ -11,7 +21,7 @@ digraph.exe {graph_path}
1121
```
1222

1323
## Graph Description JSON
14-
Writing your own JSON is quite simple. Take a look at [example1](/example_graphs/example1.json) or [example2](/example_graphs/example2.json).
24+
Writing your own JSON is quite simple. Please take a look at [example1](/example_graphs/example1.json) or [example2](/example_graphs/example2.json).
1525

1626
## Used Open Source Projects
1727
- [fmt](https://github.com/fmtlib/fmt) by Victor Zverovich and {fmt} contributors [MIT License]

src/main.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class Digraph
7272
float paths = walkMatrix.get(i, j);
7373
if (paths > 0.0f)
7474
{
75-
fmt::print("There's a path of length {} from {} to {}\n", paths, static_cast<uint32_t>(length), m_ixToVert.at(i), m_ixToVert.at(j));
75+
fmt::print("There's a path of length {} from {} to {}\n", static_cast<uint32_t>(length), m_ixToVert.at(i), m_ixToVert.at(j));
7676
pathCount++;
7777
}
7878
}
@@ -230,7 +230,7 @@ int main(int argc, char** argv)
230230
bool run = true;
231231
while (run)
232232
{
233-
int choice = menu("Choose an action:\n\t1. Look for paths with specified lenght\n\t2. Check whether the graph is acyclic\n\t3. Exit\n\nChoice: ");
233+
int choice = menu("Choose an action:\n\t1. Look for paths with specified length\n\t2. Check whether the graph is acyclic\n\t3. Exit\n\nChoice: ");
234234

235235
switch (choice)
236236
{

0 commit comments

Comments
 (0)