diff --git a/README-en.md b/README-en.md new file mode 100644 index 00000000..889de70e --- /dev/null +++ b/README-en.md @@ -0,0 +1,135 @@ +GameShell: a "game" to teach the Unix shell +=========================================== + +![Illustration inspired by the game](Images/illustration-small.png) + +Teaching first-year university students or high schoolers to use a Unix shell +is not always the easiest or most entertaining of tasks. GameShell was devised +as a tool to help students at the +[Université Savoie Mont Blanc](https://univ-smb.fr) to engage with a *real* +shell, in a way that encourages learning while also having fun. + +The original idea, due to Rodolphe Lepigre, was to run a standard bash session +with an appropriate configuration file that defined "missions" which would be +"checked" in order to progress through the game. + +Here is the result... + +![GameShell's first mission](Images/gameshell_first_mission_small.gif) + + +Feel free to send us your remarks, questions or suggestions by opening +[issues](https://github.com/phyver/GameShell/issues) or submitting +[pull requests](https://github.com/phyver/GameShell/pulls). +We are particularly interested in any new missions you might create! + + +Getting started +--------------- + +**Note:** GameShell is currently undergoing heavy development: the current +version has not been field tested by students. Do not hesitate to report any +problems you might encounter or suggestions you might have by +[opening an issue](https://github.com/phyver/GameShell/issues/new). + +GameShell should work on any standard Linux system, and also on macOS and BSD +(but we have run fewer tests on the latter systems). On Debian or Ubuntu, the +only dependencies (besides `bash`) are the `gettext-base` and `awk` packages +(the latter is generally installed by default). Some missions have additional +dependencies: these missions will be skipped if the dependencies are not met. +On Debian or Ubuntu, run the following command to install all game and mission +dependencies. +```sh +$ sudo apt install gettext man-db procps psmisc nano tree bsdmainutils x11-apps wget +``` +Check the [user manual](doc/user_manual.md) to see how to install the game +dependencies on other systems (macOS, BSD, ...). + +Assuming all the dependencies are installed, you can try the latest version of +the game by running the following two commands in a terminal. +```sh +$ wget https://github.com/phyver/GameShell/releases/download/latest/gameshell.sh +$ bash gameshell.sh +``` +The first command will download the latest version of the game in the form of +a self-extracting archive, and the second command will initialise and run the +game from the downloaded archive. Instructions on how to play are provided in +the game directly. + +Note that when you quit the game (with `control-d` or the command `gsh exit`) +your progression will be saved in a new archive (called `gameshell-save.sh`). +Run this archive to resume the game where you left it. + + +If you prefer not running foreign shell scripts on your computer, you can +generate a Docker image with the following: +```sh +$ mkdir GameShell; cd GameShell +$ wget --quiet https://github.com/phyver/GameShell/releases/download/latest/Dockerfile +$ docker build -t gsh . +$ docker run -it gsh +``` +The game will NOT be saved when you exit, and additional flags are required if +you want to run X programs from inside GameShell. Refer to [this +section](./doc/deps.md#running-GameShell-from-a-docker-container) of the user +manual. + + +Documentation +------------- + +To find out more about GameShell, refer to the following documents: +- The [user manual](doc/user_manual.md) provides information on how to run the + game on all supported platforms (Linux, macOS, BSD), explains how to run the + game from the sources, tells you how to generate custom game archives (which + is useful if you want to use GameShell for teaching a class), and more. +- The [developer manual](doc/dev_manual.md) provides information on how to + create new missions, how to translate missions, and how to participate + in the development of the game. + + +Who is developing GameShell? +---------------------------- + +### Developers + +The game is currently being developed by: +* [Pierre Hyvernat](http://www.lama.univ-smb.fr/~hyvernat) (main developer, + [pierre.hyvernat@univ-smb.fr](mailto:pierre.hyvernat@univ-smb.fr)), +* [Rodolphe Lepigre](https://lepigre.fr). + +### Mission contributors + +* Pierre Hyvernat +* Rodolphe Lepigre +* Christophe Raffalli +* Xavier Provencal +* Clovis Eberhart +* Sébastien Tavenas +* Tiemen Duvillard + +### Special thanks + +* All the students who found *many* bugs in the early versions. +* Joan Stark (a.k.a, jgs), who designed hundreds of ASCII-art pieces in the + late 90s. Most of the ASCII-art encountered in GameShell are due to her. + + +Licence +------- + +GameShell is released under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). + +Please link to this repository if you use GameShell. + +GameShell is open source and free to use. One way you can acknowledge the work +it required is by sending an actual postcard to + +``` + Pierre Hyvernat + Laboratoire de Mathématiques, CNRS UMR 5127 + Université de Savoie + 73376 Le Bourget du Lac + FRANCE +``` + diff --git a/README.md b/README.md index 889de70e..cb3c330c 100644 --- a/README.md +++ b/README.md @@ -1,104 +1,103 @@ -GameShell: a "game" to teach the Unix shell +# GameShell: un "juego" para aprender el shell de Unix =========================================== ![Illustration inspired by the game](Images/illustration-small.png) -Teaching first-year university students or high schoolers to use a Unix shell -is not always the easiest or most entertaining of tasks. GameShell was devised -as a tool to help students at the -[Université Savoie Mont Blanc](https://univ-smb.fr) to engage with a *real* -shell, in a way that encourages learning while also having fun. +Enseñar a estudiantes universitarios de primer año o estudiantes de secundaria a utilizar un shell de Unix +no siempre es la tarea más fácil o entretenida. Inicialmente, GameShell fue ideado +como una herramienta para ayudar a los estudiantes de la +[Université Savoie Mont Blanc](https://univ-smb.fr) para interactuar con un +shell *real*, de una manera que se pueda fomentar el aprendizaje y al mismo tiempo los alumnos se puedan divertir. -The original idea, due to Rodolphe Lepigre, was to run a standard bash session -with an appropriate configuration file that defined "missions" which would be -"checked" in order to progress through the game. +La idea inicial, por parte de Rodolphe Lepigre, era iniciar una sesión en bash con +un archivo de configuración que definía las "misiones", que luego sería +"validado" para avanzar en el juego. -Here is the result... +Aquí está el resultado... ![GameShell's first mission](Images/gameshell_first_mission_small.gif) -Feel free to send us your remarks, questions or suggestions by opening -[issues](https://github.com/phyver/GameShell/issues) or submitting -[pull requests](https://github.com/phyver/GameShell/pulls). -We are particularly interested in any new missions you might create! +No dudes en enviarnos tus comentarios, preguntas o sugerencias. +Podes abrir un [issues](https://github.com/phyver/GameShell/issues) o +enviar un [pull requests](https://github.com/phyver/GameShell/pulls). +Estamos particularmente interesados ​​en cualquier nueva misión que vos +podrías crear! -Getting started +Cómo jugar? --------------- -**Note:** GameShell is currently undergoing heavy development: the current -version has not been field tested by students. Do not hesitate to report any -problems you might encounter or suggestions you might have by -[opening an issue](https://github.com/phyver/GameShell/issues/new). - -GameShell should work on any standard Linux system, and also on macOS and BSD -(but we have run fewer tests on the latter systems). On Debian or Ubuntu, the -only dependencies (besides `bash`) are the `gettext-base` and `awk` packages -(the latter is generally installed by default). Some missions have additional -dependencies: these missions will be skipped if the dependencies are not met. -On Debian or Ubuntu, run the following command to install all game and mission -dependencies. +**Nota:** GameShell está en desarrollo: la versión actual +no ha sido ampliamente probada por los estudiantes. Siéntase libre de informar todo +problema que pueda encontrar y cualquier sugerencia de mejora +abriendo un [issue](https://github.com/phyver/GameShell/issues/new). + +GameShell debería funcionar en cualquier sistema Linux estándar y +también en macOS y BSD (pero estos sistemas han sido menos probados). En Debian o +Ubuntu, las únicas dependencias (aparte de `bash`) son `awk` y +`gettext-base` (el primero suele instalarse por defecto). Algunas +de las misiones tienen dependencias adicionales: se cancelarán si +las dependencias no se satisfacen. En Debian o Ubuntu, ejecute el +siguiente comando para instalar todas las dependencias de juegos y misiones. ```sh $ sudo apt install gettext man-db procps psmisc nano tree bsdmainutils x11-apps wget ``` -Check the [user manual](doc/user_manual.md) to see how to install the game -dependencies on other systems (macOS, BSD, ...). +Revisa el [user manual](doc/user_manual.md) para ver como instalar +las dependencias en otros sistemas (macOS, BSD, ...). -Assuming all the dependencies are installed, you can try the latest version of -the game by running the following two commands in a terminal. +Suponiendo que todas las dependencias estan instaladas, podes probar la última versión del +juego ejecutando los siguientes dos comandos en una terminal. ```sh $ wget https://github.com/phyver/GameShell/releases/download/latest/gameshell.sh $ bash gameshell.sh ``` -The first command will download the latest version of the game in the form of -a self-extracting archive, and the second command will initialise and run the -game from the downloaded archive. Instructions on how to play are provided in -the game directly. +El primer comando descargará la última versión del juego como un archivo autoextraíble y +el segundo comando inicializará y ejecutara el juego desde este archivo. +Las instrucciones para jugar se dan directamente en el juego. -Note that when you quit the game (with `control-d` or the command `gsh exit`) -your progression will be saved in a new archive (called `gameshell-save.sh`). -Run this archive to resume the game where you left it. +Cuando salgas del juego (con `control-d` o el comando `gsh exit`), tu progreso se guardará en un nuevo +archivo (llamado `gameshell-save.sh`). Se puede ejecutar ese script para reanudar el juego donde lo dejaste. -If you prefer not running foreign shell scripts on your computer, you can -generate a Docker image with the following: +Si prefiere no ejecutar scripts extraños en su computadora, +puede generar una imagen de Docker con : ```sh $ mkdir GameShell; cd GameShell $ wget --quiet https://github.com/phyver/GameShell/releases/download/latest/Dockerfile $ docker build -t gsh . $ docker run -it gsh ``` -The game will NOT be saved when you exit, and additional flags are required if -you want to run X programs from inside GameShell. Refer to [this -section](./doc/deps.md#running-GameShell-from-a-docker-container) of the user -manual. +**Atención:** Su progreso **NO** se guardará cuando salga del juego, +y se necesitan opciones adicionales si desea iniciar X programas desde GameShell. +Consulte [esta sección](./doc/deps.md#running-GameShell-from-a-docker-container) +del manual del usuario. -Documentation +Documentacion ------------- -To find out more about GameShell, refer to the following documents: -- The [user manual](doc/user_manual.md) provides information on how to run the - game on all supported platforms (Linux, macOS, BSD), explains how to run the - game from the sources, tells you how to generate custom game archives (which - is useful if you want to use GameShell for teaching a class), and more. -- The [developer manual](doc/dev_manual.md) provides information on how to - create new missions, how to translate missions, and how to participate - in the development of the game. +Para obtener más información sobre GameShell, están disponibles los siguientes documentos (solo en inglés): +- El [manual de usuario](doc/user_manual.md) explica, entre otras cosas, +cómo iniciar el juego en todas las plataformas compatibles (Linux, macOS, BSD), +cómo iniciar el juego desde la fuente y cómo generar un archivo +de juego personalizado (que es útil para usar el juego como parte de un curso). +- El [manual del desarrollador](doc/dev_manual.md) explica, entre otras cosas, +cómo crear una nueva misión, cómo traducir el juego y las misiones, +y cómo participar en el desarrollo del juego. -Who is developing GameShell? +¿Quién desarrolla GameShell? ---------------------------- -### Developers +### Desarrolladores -The game is currently being developed by: -* [Pierre Hyvernat](http://www.lama.univ-smb.fr/~hyvernat) (main developer, +El juego está desarrollado por: +* [Pierre Hyvernat](http://www.lama.univ-smb.fr/~hyvernat) (desarrollador principal, [pierre.hyvernat@univ-smb.fr](mailto:pierre.hyvernat@univ-smb.fr)), * [Rodolphe Lepigre](https://lepigre.fr). -### Mission contributors +### Colaboladores de misiones * Pierre Hyvernat * Rodolphe Lepigre @@ -108,22 +107,22 @@ The game is currently being developed by: * Sébastien Tavenas * Tiemen Duvillard -### Special thanks +### Agradecimientos -* All the students who found *many* bugs in the early versions. -* Joan Stark (a.k.a, jgs), who designed hundreds of ASCII-art pieces in the - late 90s. Most of the ASCII-art encountered in GameShell are due to her. +* Todos los estudiantes que probaron las primeras versiones del juego. +* Joan Stark (alias jgs) que creó cientos de arte ASCII a finales de los 90. + La mayoría del arte ASCII que encontrarás en GameShell se debe a ella. -Licence +Licencia ------- -GameShell is released under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). +GameShell se lanza bajo el [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). -Please link to this repository if you use GameShell. +Enlace a este repositorio si usa GameShell. -GameShell is open source and free to use. One way you can acknowledge the work -it required is by sending an actual postcard to +GameShell es de código abierto y de uso gratuito. +Una forma de reconocer el trabajo que requirió es enviando una postal real a ``` Pierre Hyvernat