Skip to content
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

Adapting README.md to andaluh-* library de-facto format #6

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

Adapting README.md to andaluh-* library de-facto format #6

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
47 changes: 40 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,46 @@
# Andaluh-NET
# Andaluh.NET

In order to test the code please:
Transliterate español (spanish) spelling to andaluz proposals.

For information about the inspiration for this project, please visit https://github.com/andalugeeks/andaluh-py
Have fun!

## Table of Contents

- [Description](#description)
- [Usage](#usage)
- [Installation](#installation)
- [Support](#support)
- [Contributing](#contributing)

## Description

The **Andalusian varieties of [Spanish]** (Spanish: *andaluz*; Andalusian) are spoken in Andalusia, Ceuta, Melilla, and Gibraltar. They include perhaps the most distinct of the southern variants of peninsular Spanish, differing in many respects from northern varieties, and also from Standard Spanish. Further info: https://en.wikipedia.org/wiki/Andalusian_Spanish.

This package introduces transliteration functions to convert *español* (spanish) spelling to andaluz. As there's no official or standard andaluz spelling, andaluh-py is adopting the **EPA proposal (Er Prinzipito Andaluh)**. Further info: https://andaluhepa.wordpress.com. Other andaluz spelling proposals are planned to be added as well.

## Usage

Go to `TestApp` folder type `dotnet run "Hola mundo"` to perform your own tests with your text. You don't have to type only one word but don't forget the quotation marks!

```shell
andaluh-net$ ls
Andaluh Andaluh.sln README.md TestApp Tests
andaluh-net$ cd TestApp/
andaluh-net/TestApp$ dotnet run "El veloz murciélago hindú comía feliz cardillo y kiwi. La cigüeña tocaba el saxofón detrás del palenque de paja"
Transcripción => Er belôh murçiélago indú comía felîh cardiyo y kiwi. La çigueña tocaba er çâççofón detrâh der palenque de paha
```

## Installation

- Install the latest version of the .NET Core SDK https://dotnet.microsoft.com/download/dotnet-core/3.1
- Download the code to a folder of your hard drive
- Open a console and go to the root folder of the project. I will call it `.\andaluh-net` from now on.
- Open a console and go to the root folder of the project. I will call it.
- There you can type `dotnet test` to see how the library performs (This is a bit slow as it tests 87000 cases).
- Alternatively you can go to `.\andalu-net\TestApp` and there type `dotnet run "Hola mundo"` and perform your own tests with your own text. You don't have to type only one word but don't forget the quotation marks!

For more information about the project please visit https://github.com/andalugeeks/andaluh-py
## Support

Have fun!
Please [open an issue](https://github.com/andalugeeks/andaluh-net/issues/new) for support.

## Contributing

Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and open a pull request.