Skip to content

Commit

Permalink
guide: move one screenshot to the front page
Browse files Browse the repository at this point in the history
This used to work with the old asciidoc README.

Change-Id: I974137b53a924972eec55c0e0f579ffa95303302
  • Loading branch information
vmiklos committed Jan 11, 2023
1 parent b228b17 commit 4ac0f83
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/tests.yml
Expand Up @@ -16,7 +16,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.9
python-version: 3.10
- name: Run make check
run: |
tools/ci-build.sh
Expand All @@ -32,7 +32,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.9
python-version: 3.10
- name: Run make check
run: |
tools/ci-build.sh
Expand All @@ -48,7 +48,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.9
python-version: 3.10
- name: Run make pack
run: |
tools/ci-build.ps1
Expand Down
4 changes: 4 additions & 0 deletions guide/src/README.md
Expand Up @@ -12,6 +12,10 @@ map individuals and families to graph nodes and connections between them to grap
takes care of the rest. What's unique about `ged2dot` is that it allows more than showing ancestors
and descendants of a single individual (what you can easily do with random family editor software).

It looks like this:

![screenshot](https://vmiklos.hu/ged2dot/tests/screenshot.png)

## Contributing

ged2dot is free and open source. You can find the source code on
Expand Down
4 changes: 1 addition & 3 deletions guide/src/usage.md
Expand Up @@ -18,9 +18,7 @@ nodes around the root family.

## Layout

The layout does a Breadth First Search (BFS) traversal on the graph, from the starting family:

![screenshot](https://vmiklos.hu/ged2dot/tests/screenshot.png)
The layout does a Breadth First Search (BFS) traversal on the graph, from the starting family.

This has several benefits over explicitly trying to guess which family belongs to which generation.
Some example more tricky cases, which are handled by `ged2dot`:
Expand Down

0 comments on commit 4ac0f83

Please sign in to comment.