Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ahandsel committed Nov 15, 2023
1 parent 0f8b04e commit f82eb16
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
# Intro to Kintone Slides

This is a slide deck for a quick introduction to Kintone. Perfect for a 5-10 minute presentation.

![Slide 1](screenshots/01.png)

| Item | URL |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Slide Deck | [ahandsel.github.io/kintone-quick-intro-slides](https://ahandsel.github.io/kintone-quick-intro-slides/) |
| Presenter | [ahandsel.github.io/kintone-quick-intro-slides/presenter](https://ahandsel.github.io/kintone-quick-intro-slides/presenter/) |
| Markdown | [slides.md](slides.md) |
| PDF | [slides.pdf](slides.pdf) |
| PNG | [screenshots](screenshots) |

## Kintone Resources

| Links to Resources | Description |
| ---------------------------------------------------------------------------- | ------------------------- |
| [kintone.dev](https://kintone.dev/) | Read API Docs & Tutorials |
| [forum.kintone.dev](https://forum.kintone.dev/) | Post Questions |
| [@KintoneDeveloperProgram](https://www.youtube.com/@KintoneDeveloperProgram) | Watch Tutorials |

## Repo Usage

The slide deck is built using [Sli.dev](https://sli.dev/).

How to open the slides locally:

1. `git clone`
Expand All @@ -13,8 +35,7 @@ How to open the slides locally:

How to deploy on GitHub Pages:

1. Modify [deploy.yml](.github/workflows/deploy.yml) file to use your repo name - [Sli.Dev HelpDoc](https://sli.dev/guide/hosting.html#github-pages)
1. Modify [package.json](package.json)'s `buildBase` to use your repo name - [Sli.Dev HelpDoc](https://sli.dev/guide/hosting.html#github-pages)
1. Commit changes to the `main` branch
1. From your GitHub Repo page: Repo `⚙️ Settings` > `Pages` > `Build and deployment` > `Branch`, select `gh-pages` and `/root`
1. Click on `Save`!
1. From your GitHub Repo page: Repo `⚙️ Settings` > `Pages` > `Build and deployment` > Select `GitHub Actions` for Source
1. Finally, after all workflows are executed, a link to the slides should appear under Setting > Pages

0 comments on commit f82eb16

Please sign in to comment.