Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ofek committed Oct 13, 2024
1 parent 7af2183 commit 07a2f28
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 28 deletions.
42 changes: 23 additions & 19 deletions docs/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,19 @@ Follow [the instructions](https://www.rust-lang.org/tools/install) to install Ru

In order to [build](build.md) applications with PyApp, you must first download the source code. Here we will download the latest release.

=== "Linux/macOS"
1. `curl https://github.com/ofek/pyapp/releases/latest/download/source.tar.gz -Lo pyapp-source.tar.gz`
2. `tar -xzf pyapp-source.tar.gz`
3. `mv pyapp-v* pyapp-latest`
4. `cd pyapp-latest`

=== "Windows"
1. `Invoke-WebRequest https://github.com/ofek/pyapp/releases/latest/download/source.zip -OutFile pyapp-source.zip`
2. `7z x pyapp-source.zip`
3. `mv pyapp-v* pyapp-latest`
4. `cd pyapp-latest`
/// tab | Linux/macOS
1. `curl https://github.com/ofek/pyapp/releases/latest/download/source.tar.gz -Lo pyapp-source.tar.gz`
2. `tar -xzf pyapp-source.tar.gz`
3. `mv pyapp-v* pyapp-latest`
4. `cd pyapp-latest`
///

/// tab | Windows
1. `Invoke-WebRequest https://github.com/ofek/pyapp/releases/latest/download/source.zip -OutFile pyapp-source.zip`
2. `7z x pyapp-source.zip`
3. `mv pyapp-v* pyapp-latest`
4. `cd pyapp-latest`
///

## Configuration

Expand All @@ -47,15 +49,17 @@ The executable will be located at `target/release/pyapp.exe` if on Windows or `t

Be sure to rename the binary to the name of the application (and make it executable on non-Windows systems):

=== "Linux/macOS"
```
mv target/release/pyapp cowsay && chmod +x cowsay
```
/// tab | Linux/macOS
```
mv target/release/pyapp cowsay && chmod +x cowsay
```
///

=== "Windows"
```
mv target\release\pyapp.exe cowsay
```
/// tab | Windows
```
mv target\release\pyapp.exe cowsay
```
///

## Runtime

Expand Down
13 changes: 12 additions & 1 deletion docs/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,21 @@ The following is not intended to be a complete enumeration. Be sure to view the
## Projects

[AppleCrate](https://github.com/RhetTbull/applecrate/blob/16c357311832732a01f14c6cd1fcec1230065f21/scripts/pyapp-runner.sh)
| [Datadog QA](https://github.com/DataDog/ddqa/blob/65f42f60b10da60084ef115cee7eee276a3a15fb/.github/workflows/build.yml#L101)
| [FreeMoCap](https://github.com/freemocap/freemocap/releases/tag/1.1.0)
| [Hatch](https://github.com/pypa/hatch/blob/c4bb4b489c4c2eb2cf8b1ea64b06a63f165c843e/.github/workflows/build-hatch.yml#L101)
| [instawow](https://github.com/layday/instawow/blob/ad0ca23352b9c4647b55ffd5b90151bf30d571f7/noxfile.py#L184)
| [Litestar](https://github.com/litestar-org/litestar-fullstack/blob/dc72eee78173790c3e91b0c095ac9e70ba91bedd/scripts/post-builds.py)
| [Plutus Terminal](https://github.com/plutus-terminal/plutus-terminal/blob/65d1d34f94764bf7ce1383d836780cf8f0f02f4c/.github/workflows/release.yml#L90)
| [Preservation Workbench](https://github.com/Preservation-Workbench/PWCode/blob/e7777806be35bd60ca8c33e677ffd77e38b277d0/build/make.sh)
| [tidal-wave](https://github.com/ebb-earl-co/tidal-wave/blob/6358ede21adb715a053b1e6cc73968933c3bed05/BUILDME.md#pyapp-created-binaries)

## Industry

- [Beam](https://www.beam.cloud) <sup>\[[1](https://github.com/beam-cloud/beta9/blob/6cf1879bd35613505ee6ccf6658bc76b1748dfd1/.github/workflows/release-cli.yml#L75)|[2](https://github.com/beam-cloud/beam-client/blob/f745d83047ae92313fd1bb5145b09e47eaf0d98f/.github/workflows/release-cli.yml#L87)\]</sup>
- [Blueshoe](https://www.blueshoe.io) <sup>\[[1](https://github.com/gefyrahq/gefyra/blob/6eb902985f9f470daad3cbe331cfcb4b1642fa02/.github/workflows/dist-build-linux.yaml#L34)\]</sup>
- [Datadog](https://www.datadoghq.com) <sup>\[[1](https://github.com/DataDog/integrations-core/blob/aa0f178b04b4497758213cbbaafd32927ad85d51/.github/workflows/build-ddev.yml#L204)|[2](https://github.com/DataDog/ddqa/blob/65f42f60b10da60084ef115cee7eee276a3a15fb/.github/workflows/build.yml#L101)\]</sup>

## Academia

- [École Polytechnique Fédérale de Lausanne (EPFL)](https://www.epfl.ch/en/)
- [Center for Imaging](https://imaging.epfl.ch) <sup>\[[1](https://github.com/EPFL-Center-for-Imaging/depalma-napari-omero/blob/ea3fbd156799f95ddf482e382e37060c6ae3a9fb/pyapp/build.py#L14)\]</sup>
14 changes: 7 additions & 7 deletions hatch.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
detached = true
installer = "uv"
dependencies = [
"mkdocs~=1.6.0",
"mkdocs-material~=9.5.22",
"mkdocs~=1.6.1",
"mkdocs-material~=9.5.40",
# Plugins
"mkdocs-minify-plugin~=0.8.0",
"mkdocs-git-revision-date-localized-plugin~=1.2.4",
"mkdocs-glightbox~=0.3.7",
"mkdocs-git-revision-date-localized-plugin~=1.2.9",
"mkdocs-glightbox~=0.4.0",
"mkdocs-redirects~=1.2.1",
"mike~=2.0.0",
"mike~=2.1.3",
# Extensions
"pymdown-extensions~=10.8.0",
"pymdown-extensions~=10.11.2",
# Necessary for syntax highlighting in code blocks
"pygments~=2.17.2",
"pygments~=2.18.0",
# Validation
# https://github.com/linkchecker/linkchecker/pull/669#issuecomment-1267236287
"linkchecker @ git+https://github.com/linkchecker/linkchecker.git@d9265bb71c2054bf57b8c5734a4825d62505c779",
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
- pymdownx.blocks.tab:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
Expand Down

0 comments on commit 07a2f28

Please sign in to comment.