Skip to content

Commit

Permalink
add readmes for examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Aylur committed Mar 8, 2024
1 parent 987894c commit b7bf238
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 0 deletions.
19 changes: 19 additions & 0 deletions example/applauncher/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Application Launcher

setup

```bash
mkdir -p ~/.config/ags
git clone https://github.com/Aylur/ags.git /tmp/ags
cp -r /tmp/ags/example/applauncher/* ~/.config/ags

# optionally setup types
ags --init -c ~/.config/ags/config.js
```

running

```bash
ags -c ~/.config/ags/config.js &
ags -t applauncher
```
18 changes: 18 additions & 0 deletions example/media-widget/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Media Widget

setup

```bash
mkdir -p ~/.config/ags
git clone https://github.com/Aylur/ags.git /tmp/ags
cp -r /tmp/ags/example/media-widget/* ~/.config/ags

# optionally setup types
ags --init -c ~/.config/ags/config.js
```

running

```bash
ags -c ~/.config/ags/config.js &
```
18 changes: 18 additions & 0 deletions example/notification-popups/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Notification Popups

setup

```bash
mkdir -p ~/.config/ags
git clone https://github.com/Aylur/ags.git /tmp/ags
cp -r /tmp/ags/example/notification-popups/* ~/.config/ags

# optionally setup types
ags --init -c ~/.config/ags/config.js
```

running

```bash
ags -c ~/.config/ags/config.js &
```
18 changes: 18 additions & 0 deletions example/simple-bar/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Simple Bar

setup

```bash
mkdir -p ~/.config/ags
git clone https://github.com/Aylur/ags.git /tmp/ags
cp -r /tmp/ags/example/simple-bar/* ~/.config/ags

# optionally setup types
ags --init -c ~/.config/ags/config.js
```

running

```bash
ags -c ~/.config/ags/config.js &
```
21 changes: 21 additions & 0 deletions example/ts-starter-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# TypeScript Starter Config

Dependency: `bun`

```bash
mkdir -p ~/.config/ags
git clone https://github.com/Aylur/ags.git /tmp/ags
cp -r /tmp/ags/example/ts-starter-config/* ~/.config/ags
```

optionally setup types

```bash
ags --init -c ~/.config/ags/config.js
```

running

```bash
ags -c ~/.config/ags/config.js &
```

0 comments on commit b7bf238

Please sign in to comment.