Skip to content

Commit

Permalink
Add README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lulunac27a committed Aug 5, 2024
1 parent 6292e6e commit d083395
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: docs
on:
push:
branches:
- master
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Character Typing Game using TypeScript

This app is a typing game that asks users to type the character on the screen. It uses TypeScript for type-checking and type annotations.

## Getting Started

```
git clone https://github.com/lulunac27a/typescript-character-typing-game.git
cd typescript-character-typing-game
npm install
npm run compile
npm run start
```
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Character Typing Game using TypeScript

This app is a typing game that asks users to type the character on the screen. It uses TypeScript for type-checking and type annotations.

## Getting Started

```
git clone https://github.com/lulunac27a/typescript-character-typing-game.git
cd typescript-character-typing-game
npm install
npm run compile
npm run start
```
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
site_name: TypeScript Character Typing Game
theme: material
repo_url: https://github.com/lulunac27a/typescript-character-typing-game

0 comments on commit d083395

Please sign in to comment.