Skip to content

Commit

Permalink
Preparando la documentación multilingüe
Browse files Browse the repository at this point in the history
  • Loading branch information
emilioplatzer committed Aug 23, 2015
1 parent eaa1f01 commit 8260864
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 4 deletions.
67 changes: 67 additions & 0 deletions LEEME.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!-- multilang from README.md
NO MODIFIQUE ESTE ARCHIVO. FUE GENERADO AUTOMÁTICAMENTE POR multilang.js
-->
# eiffel
Painless Contracts in Javascript



Contratos en Javascript similar a lenguaje Eiffel


<!-- cucardas -->

<!--multilang buttons-->

idioma: ![castellano](https://raw.githubusercontent.com/codenautas/multilang/master/img/lang-es.png)
también disponible en:
[![inglés](https://raw.githubusercontent.com/codenautas/multilang/master/img/lang-en.png)](README.md)


## Instalación


```sh
> npm install eiffel
```


Con **Eiffel** se agregan contratos en Javascript sin necesidad de cambiar la definición original de las funciones.
Al igual que en el **lenguaje Eiffel** los contratos están escritos en el lenguaje nativo (Javascript)
y pueden ser fácilmente activados y desactivados.

# Características principales
* Las funciones se declaran de la forma usual
* Se declaran cláusulas *require* y *ensure* (tipo Eiffel) en cualqueir lugar del código
* Se pueden activar y desactivar sin necesidad de cambiar el código

## Ejemplos


```js
function intRandom(min, max){
return Math.floor(Math.random()*(max-min+1)+min);
}

Eiffel.global('intRandom',{
require:function(min, max){
return !isNaN(min) && !isNaN(max) && min<=max;
},
ensure:function(result, min, max){
return result.returned>=min && result.returned<=max;
}
});
```


*Más*:
* Hay un ejemplo no trivial en [eiffel_demo.js](example/eiffel_demo.js) (resolviendo una equación cuadrática).
* una [Introducción](doc/introduccion.md) más amplia
57 changes: 53 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
# eiffel
Painless Contracts in Javascript

<!--multilang v0 en:README.md es:LEEME.md -->

<!--lang:es--]
Contratos en Javascript similar a lenguaje Eiffel
[!--lang:*-->

<!-- cucardas -->

<!--multilang buttons-->

language: ![English](https://raw.githubusercontent.com/codenautas/multilang/master/img/lang-en.png)
also available in:
[![Spanish](https://raw.githubusercontent.com/codenautas/multilang/master/img/lang-es.png)](LEEME.md) -

<!--lang:en-->

## Instalation

<!--lang:es--]
## Instalación
[!--lang:*-->

```sh
> npm install eiffel
```

<!--lang:en-->

Add Contracts in Javascript without changing the function definitions.
Like in Eiffel contracts are writing in native language (Javascript) with minimal function calls and can easily enabled and disabled.

Expand All @@ -12,6 +44,21 @@ Like in Eiffel contracts are writing in native language (Javascript) with minima

## Examples

<!--lang:es--]
Con **Eiffel** se agregan contratos en Javascript sin necesidad de cambiar la definición original de las funciones.
Al igual que en el **lenguaje Eiffel** los contratos están escritos en el lenguaje nativo (Javascript)
y pueden ser fácilmente activados y desactivados.
# Características principales
* Las funciones se declaran de la forma usual
* Se declaran cláusulas *require* y *ensure* (tipo Eiffel) en cualqueir lugar del código
* Se pueden activar y desactivar sin necesidad de cambiar el código
## Ejemplos
[!--lang:*-->

```js
function intRandom(min, max){
return Math.floor(Math.random()*(max-min+1)+min);
Expand All @@ -27,10 +74,12 @@ Eiffel.global('intRandom',{
});
```

*More*: A non nonsense example in [eiffel_demo.js](example/eiffel_demo.js) (solving quadratic equations).
[!--lang:en-->

## My apologies
I'm not native English speaker. Corrections are wellcome.
*More*: A non nonsense example in [eiffel_demo.js](example/eiffel_demo.js) (solving quadratic equations).

Spanish documentation in [Introducción](doc/introduccion.md)
<!--lang:es--]
*Más*:
* Hay un ejemplo no trivial en [eiffel_demo.js](example/eiffel_demo.js) (resolviendo una equación cuadrática).
* una [Introducción](doc/introduccion.md) más amplia
7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,12 @@
"test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",
"test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
"start": "node example/server.js"
},
"qa-control": {
"package-version": "0.0.1",
"coverage": 90,
"run-in": "both",
"stability": "extending",
"type": "lib"
}
}

0 comments on commit 8260864

Please sign in to comment.