Skip to content

Commit 54ef5a2

Browse files
committed
Update site with basic info
1 parent f74ac7b commit 54ef5a2

6 files changed

Lines changed: 26 additions & 27 deletions

File tree

Gemfile.lock

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ GEM
1111
eventmachine (1.2.7)
1212
ffi (1.16.3)
1313
forwardable-extended (2.6.0)
14-
google-protobuf (3.25.1-arm64-darwin)
15-
google-protobuf (3.25.1-x86_64-linux)
14+
google-protobuf (3.25.2)
1615
http_parser.rb (0.8.0)
1716
i18n (1.14.1)
1817
concurrent-ruby (~> 1.0)

_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
title: Just the Docs Template
2-
description: A starter template for a Jeykll site using the Just the Docs theme!
1+
title: Proof Frog
2+
description: A tool for verifying game-hopping proofs
33
theme: just-the-docs
44

55
url: https://just-the-docs.github.io
66

77
aux_links:
8-
Template Repository: https://github.com/just-the-docs/just-the-docs-template
8+
ProofFrog Hub: https://github.com/ProofFrog

_sass/custom/custom.scss

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.site-title::after {
2+
background-image: url("../../prooffrog.png");
3+
width: 46px;
4+
height: 40px;
5+
content: "";
6+
background-size: cover;
7+
margin-left: 10px;
8+
}

favicon.ico

15 KB
Binary file not shown.

index.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,27 @@
11
---
2-
title: Home
2+
title: Proof Frog
33
layout: home
44
---
55

6-
This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
6+
ProofFrog is a tool for verifying game-hopping proofs.
77

8-
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
8+
# Installation
99

10-
More specifically, the created site:
10+
ProofFrog is implemented in python and can be installed using `pip`:
1111

12-
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
13-
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
12+
`pip install proof_frog`
1413

15-
Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
14+
The `proof_frog` CLI will then be available on your PATH.
1615

17-
[Browse our documentation][Just the Docs] to learn more about how to use this theme.
16+
Examples of proof_frog files can be found in the [examples git repository](https://github.com/ProofFrog/examples).
1817

19-
To get started with creating a site, simply:
18+
For example:
2019

21-
1. click "[use this template]" to create a GitHub repository
22-
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
20+
```
21+
git clone git@github.com:ProofFrog/examples.git
22+
proof_frog prove 'examples/Proofs/SymEnc/OTUC=>OTS.proof'
23+
```
2324

24-
If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
25+
# Development
2526

26-
----
27-
28-
[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
29-
30-
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
31-
[GitHub Pages]: https://docs.github.com/en/pages
32-
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
33-
[Jekyll]: https://jekyllrb.com
34-
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
35-
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
27+
See the [GitHub repo](https://github.com/ProofFrog/ProofFrog) for source code and development information.

prooffrog.png

268 KB
Loading

0 commit comments

Comments
 (0)