Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
OmarSamirz committed Sep 9, 2024
1 parent b692992 commit b025ecf
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 290 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: IFTG

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'

- name: Install dependencies
run: |
pip install mkdocs mkdocs-material
- name: Build MkDocs site
run: |
mkdocs build
- name: Setup Pages
uses: actions/configure-pages@v3

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./site

deploy:
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: build

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
<h1>ImageFromTextGenerator</h1>
</div>


![PyPI - Version](https://img.shields.io/pypi/v/iftg)
[![Build Status](https://app.travis-ci.com/OmarSamirz/ImageFromTextGenerator.svg?token=sD96ekdrKiXZ1PgQDJDX&branch=main)](https://app.travis-ci.com/OmarSamirz/ImageFromTextGenerator)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/OmarSamirz/ImageFromTextGenerator/.%2F.github%2Fworkflows%2Ftest.yml)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FOmarSamirz%2FImageFromTextGenerator.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FOmarSamirz%2FImageFromTextGenerator?ref=badge_shield&issueType=license)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FOmarSamirz%2FImageFromTextGenerator.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2FOmarSamirz%2FImageFromTextGenerator?ref=badge_shield&issueType=security)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/iftg)
Expand Down Expand Up @@ -154,7 +155,7 @@ To get started with IFTG, follow these simple steps:
- **ImageNoiseAdder:** ImageNoiseAdder class is designed to test and add noises to existing image in a specific directory.

Usage Example:
```pyfrom
```py
iftg.adders import ImageNoiseAdder
from iftg.noises import PixelDropoutNoise

Expand Down
Loading

0 comments on commit b025ecf

Please sign in to comment.