Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samuelfatzinger wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@
[![Coverage Status](https://coveralls.io/repos/github/OpenGreekAndLatin/ILA_python/badge.svg?branch=master)](https://coveralls.io/github/OpenGreekAndLatin/ILA_python?branch=master)
[![Documentation Status](https://readthedocs.org/projects/ila-python/badge/?version=latest)](http://ila-python.readthedocs.io/en/latest/?badge=latest)

# Intra Language Alignment tool
# Intra Language Alignment Tool

The tool allows automatic alignment between multiple texts in the same language, for the detection of textual variants and minor instances of re-use.
## Overview

This tool allows automatic alignment between multiple texts in the same language for the detection of textual variants and minor instances of reuse.

## Installation

Install the package locally:
`pip install .`

Or for development:
`pip install -e .`

## Usage

Import the `iAlignment` package in Python:
`import iAlignment`

The package provides tools for aligning and comparing texts within the same language.

## Examples

The `examples/` directory contains sample scripts, input data, and HTML output files demonstrating how to use the tool.

These examples provide a starting point for running alignments and viewing the resulting output.

## Requirements

- Python 3.4+