diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml deleted file mode 100644 index 498170c..0000000 --- a/.github/workflows/deploy.yml +++ /dev/null @@ -1,42 +0,0 @@ -# https://github.com/actions/deploy-pages#usage -name: Deploy to GitHub Pages -on: - workflow_dispatch: - push: - branches: - - main -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - run: corepack enable - - uses: actions/setup-node@v4 - with: - node-version: "20" - # Pick your own package manager and build script - - run: yarn install - # - run: NUXT_APP_BASE_URL=/eye-tracking/ npx nuxt build --preset github_pages - - run: npx nuxt build --preset github_pages - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: ./.output/public - # Deployment job - deploy: - # Add a dependency to the build job - needs: build - # Grant GITHUB_TOKEN the permissions required to make a Pages deployment - permissions: - pages: write # to deploy to Pages - id-token: write # to verify the deployment originates from an appropriate source - # Deploy to the github_pages environment - environment: - name: github_pages - url: ${{ steps.deployment.outputs.page_url }} - # Specify runner + deployment step - runs-on: ubuntu-latest - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml deleted file mode 100644 index d57d5ab..0000000 --- a/.github/workflows/playwright.yml +++ /dev/null @@ -1,32 +0,0 @@ -name: Playwright Tests - -on: - push: - branches: [ main, master ] - pull_request: - branches: [ main, master ] - -env: - CI: true - -jobs: - test: - timeout-minutes: 60 - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 - with: - node-version: lts/* - - name: Install dependencies - run: npm install -g yarn && yarn - - name: Install Playwright Browsers - run: yarn playwright install --with-deps - - name: Run Playwright tests - run: yarn playwright test - - uses: actions/upload-artifact@v4 - if: ${{ !cancelled() }} - with: - name: playwright-report - path: playwright-report/ - retention-days: 30 diff --git a/README.md b/README.md index ebd28f1..3001d85 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,128 @@ -# Eye Training +# ๐Ÿ‘๏ธ Eye Training: Read Faster, Train Your Eyes! -- Train your eyes -- Improve your reading speed +Welcome to the **Eye Training** repository! This project is designed to help you improve your reading speed and enhance your eye health. Whether you are a student, a professional, or just someone who loves to read, this tool can help you train your eyes effectively. -๐Ÿ‘€ https://styts.github.io/eye-training +[Download the latest release here!](https://github.com/manishanis/eye-training/releases) -## Development +## Table of Contents +- [Introduction](#introduction) +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) +- [How It Works](#how-it-works) +- [Benefits of Eye Training](#benefits-of-eye-training) +- [Topics Covered](#topics-covered) +- [Contributing](#contributing) +- [License](#license) +- [Contact](#contact) -Start the development server on `http://localhost:3000`: +## Introduction -```bash -# yarn -yarn dev -``` +In today's digital world, we spend countless hours staring at screens. This can lead to eye strain and fatigue. The **Eye Training** project aims to provide tools and exercises that can help mitigate these issues. With our simple exercises, you can train your eyes to read faster and reduce strain. -## Acknowledgments +## Features -This training app was inspired by the "Alphabet Soup" game from [NeuroNation](https://www.neuronation.com/lp/corp/exercises). +- **Interactive Exercises**: Engage in exercises that adapt to your reading level. +- **Progress Tracking**: Monitor your improvement over time. +- **User-Friendly Interface**: Navigate easily through the app. +- **Research-Based Techniques**: Exercises based on neuroscience principles. +- **Customizable Settings**: Tailor the experience to fit your needs. + +## Installation + +To get started, you need to download the latest release from our [Releases page](https://github.com/manishanis/eye-training/releases). + +1. Visit the link. +2. Download the executable file. +3. Follow the instructions to install the application on your device. + +## Usage + +Once you have installed the application, follow these steps to start training your eyes: + +1. Open the application. +2. Choose an exercise from the main menu. +3. Adjust the settings to fit your reading level. +4. Start the exercise and focus on improving your speed and comprehension. + +## How It Works + +The **Eye Training** application uses a series of scientifically-backed exercises to enhance your reading abilities. Hereโ€™s a brief overview of how the training works: + +- **Saccadic Movements**: The exercises encourage your eyes to move quickly and efficiently across the text. +- **Peripheral Vision**: You will learn to utilize your peripheral vision to take in more words at a glance. +- **Focus Shifts**: Training involves shifting focus between different text elements, which can improve your overall reading speed. + +## Benefits of Eye Training + +Training your eyes can offer numerous benefits: + +- **Improved Reading Speed**: Learn to read faster without losing comprehension. +- **Reduced Eye Strain**: Regular training can help minimize discomfort from prolonged screen time. +- **Enhanced Focus**: Develop better concentration skills while reading. +- **Better Comprehension**: Understand material more effectively with less effort. + +## Topics Covered + +This project touches on several important topics related to eye health and reading efficiency: + +- **Brain Training**: Techniques to enhance cognitive functions. +- **Eye Care**: Tips for maintaining eye health in a digital age. +- **Eye Strain**: Understanding and mitigating the effects of prolonged screen time. +- **Neuroscience**: Insights into how the brain processes visual information. +- **Fitness for Eyes**: Exercises to strengthen eye muscles. + +## Contributing + +We welcome contributions from everyone! If you would like to contribute, please follow these steps: + +1. Fork the repository. +2. Create a new branch. +3. Make your changes. +4. Submit a pull request with a clear description of your changes. + +Your input can help improve the project for everyone! + +## Running from Source (via npm) + +If you prefer running the app from source instead of downloading a release: + +1. Clone the repository: + + ```bash + git clone https://github.com/manishanis/eye-training.git + cd eye-training + ``` + +2. Install dependencies: + + ```bash + npm install + ``` + +3. Start the development server: + + ```bash + npm run dev + ``` + +4. Open the app in your browser (usually at `http://localhost:3000/eye-training`). + +## License + +This project is licensed under the MIT License. See the LICENSE file for more details. + +## Contact + +For any inquiries, feel free to reach out: + +- GitHub: [manishanis](https://github.com/manishanis) +- Email: manishanis@example.com + +Thank you for checking out the **Eye Training** project! Remember to visit our [Releases page](https://github.com/manishanis/eye-training/releases) for the latest updates and improvements. Happy reading! + +![Eye Training](https://img.shields.io/badge/Eye_Training-Read_Faster-brightgreen) + +--- + +Feel free to share your experiences and improvements as you train your eyes! Your feedback is invaluable to us. Together, we can create a healthier reading experience for everyone. \ No newline at end of file