diff --git a/README.md b/README.md index f3773d71..014e67d8 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,85 @@ -![](disroot_h2_title.png) +

-# Disroot's How-tos & Translations +![](h2.png) -| [Disroot Howtos](https://howto.disroot.org) | [Disroot Website](https://disroot.org) | +

+ +

Disroot's How-tos & Translations

+ +

· Get involved and contribute ·

+ + +
----- This repository contains the **Disroot's Howto Project** files and the information to create, modify and translate those files. The main objective of the **Disroot's Howto Project** is the creation, maintenance and accessibility of user guides, tutorials and configurations of the different services and software that the **Disroot** platform provides. And also provide the tools, instructions and procedures for anyone who wants to contribute by creating, modifying and translating these guides. -## Table of contents -* [Prerequisites](#prerequisites) - - Software required - - Gitea account - - Request access to our repository - - Setting your username and email -* [Creating / Translating Howto's](#creating-translating-howtos) - - Cloning the repository - - Creating / Translating instructions -* [License](#license) +
----- -## Prerequisites +# 1. Prerequisites + - a. Software required + - b. Gitea accountvh + - c. Request access to our repository + - d. Setting your username and email + In order to get a copy of the project on your local machine and start to work, you should follow these instructions. -### 01. Software required: +## a. Software required: First of all, you need to have installed the following software. -- **git**
+- ## git
A version control system for tracking the changes that are implemented to the howtos and translations as they're being written.
-[**What is git?**](https://en.wikipedia.org/wiki/Git) / [**Download & installation instructions**](https://git-scm.com/downloads) / [**Disroot's Git Basics Howto**](https://howto.disroot.org/en/contribute/git/how-to-use-git) +· [**What is git?**](https://en.wikipedia.org/wiki/Git)
· [**Download & installation instructions**](https://git-scm.com/downloads) -- A text editor with markdown format files support
-Suggested software: **Atom Text Editor**, a source code editor with git version control integrated.
-[**Download & installation instructions**](https://flight-manual.atom.io/getting-started/sections/installing-atom/) +- ## A text editor with markdown format files support
+_Suggested software:_
+· **VSCodium**, a community-driven, freely-licensed binary distribution of Microsoft’s editor VS Code. [[**Download & installation instructions**](https://vscodium.com/)]
+· **Neovim**, a hyperextensible Vim-based text editor. [[**Download & installation instructions**](https://github.com/neovim/neovim/wiki/Installing-Neovim)]
+· **Kate Editor**, a feature packed text editor. [[**Download & installation instructions**](https://kate-editor.org/get-it/)] -### 02. Gitea account -In order to send changes you make to the howtos, whether translating, editing, or writing them, you need to have an account in a **Gitea** instance. +
+ +## b. A Gitea account +To be able to send changes you make to the howtos, whether translating, editing, or writing them, you need to have an account in a **Gitea** instance. To register an account at the instance where our repository is, go [**here**](https://git.disroot.org/user/sign_up). -### 03. Request access to our repository -In order to be able to commit changes to **Disroot**'s git repository, you'll need to request access. This is done via our git project page +
-### 04. Setting your username and email +## c. Request access to our repository +In order to be able to commit changes to **Disroot**'s git repository, you'll need to request access. This is done via our git project page. + +
+ +## d. Setting your username and email This is necessary to be able to send your work from your machine to the remote repository. To setup the git username and email - open a terminal and start git
`git init`
- type and complete with your information the following commands:
-`git config --global user.email user@email`
+`git config --global user.email "user@email"`
`git config --global user.name "User Name"` +
-## Creating / Translating Howto's + +# 2. Creating / Translating Howto's The process of creating or translating howtos is not difficult and requires only a bit of practice to learn. +The procedure is pretty simple: + +1. You get a copy of the files you are going to work on; +2. you work locally in your computer on the files, +3. and once you have finished, you submit them. + + The first thing to do is cloning the repository, this means making a local copy of the remote files. All the work will be done on this copy. -### Cloning the repository +
+ +## a. Cloning the repository A git repository is a project folder containing the files created or to be translated and the detailed track history of those changes. To clone the repository, open a terminal in the directory you would like to clone the repository to. Once there you'll use the `git clone` command, an instruction to clone a repository by typing its address. In our case it would be: @@ -68,12 +88,16 @@ To clone the repository, open a terminal in the directory you would like to clon Once the repository has been copied to your hard drive you'll see a `howto` directory containing all the files of the project. It can be later moved to any place on your computer. -### Creating / Translating instructions +
+ +## b. Creating / Translating instructions Once you have copied the repository to your machine, you can start creating, editing and/or translating by following the steps described in these guides: -- [Howto use git for **Disroot**'s Howtos](https://howto.disroot.org/en/contribute/git/how-to-use-git)
+- [Howto to contribute to **Disroot**'s Howtos](https://howto.disroot.org/en/contribute)
-- [**Disroot**'s Translation procedure](https://howto.disroot.org/en/contribute/translations_procedure) +- [Howtos and Translation procedure](https://howto.disroot.org/en/contribute/procedure) -## License +
+ +# 3. License The **Disroot's Howto** documentation is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/) diff --git a/README_ES.md b/README_ES.md index d16f0902..24479df0 100644 --- a/README_ES.md +++ b/README_ES.md @@ -1,65 +1,85 @@ -![](disroot_h2_title.png) +

-# Guías/Tutoriales y Traducciones de Disroot +![](h2.png) -| [Disroot Guías](https://howto.disroot.org/es) | [Disroot Website](https://disroot.org/es) | +

+ +

Guías & Traducciones de Disroot

+ +

· Involúcrate y contribuye ·

+ + +
----- Este repositorio contiene los archivos del **Proyecto Howto de Disroot** y la información para crear, modificar y traducir esos archivos. El principal objetivo del **Proyecto Howto de Disroot** es la creación, mantenimiento y accesibilidad de guías para usuarias y usuarios, tutoriales y configuraciones de los diferentes servicios y software que ofrece la plataforma **Disroot**. Y también proveer las herramientas, instrucciones y procedimientos para cualquiera que quiera contribuir creando, modificando y traduciendo estas guías. -## Contenidos -* [Requisitos](#requisitos) - - Software necesario - - Cuenta en una instancia **Gitea** - - Solicitar acceso a nuestros repositorios - - Configurar tu nombre de usuari@ y correo -* [Crear / Traducir Guías](#crear-traducir-guias) - - Clonar el repositorio - - Instrucciones para la Creación / Traducción -* [Licencia](#licencia) +
----- -## Requisitos +# Prerrequisitos + - a. Software necesario + - b. Cuenta en una instancia **Gitea** + - c. Solicitar acceso a nuestros repositorios + - d. Configurar tu nombre de usuari@ y correo + Para poder obtener una copia del proyecto en un máquina local y comenzar a trabajar, debes seguir estas instrucciones. -### 01. Software necesario: +## a. Software necesario: Primero, necesitas tener instalado el siguiente software. -- **git**
-Un sistema de control de versiones para el seguimiento de los cambios que son implementados en las guías y las traducciones mientras están siendo escritas.
-[**¿Qué es git?**](https://es.wikipedia.org/wiki/Git) / [**Descarga**](https://git-scm.com/downloads) / [**Instrucciones de instalación**](https://git-scm.com/book/es/v1/Empezando-Instalando-Git) / [**Guía básica de uso de Git de Disroot**](https://howto.disroot.org/es/contribute/git/how-to-use-git) -- Un editor de texto con soporte para archivos con formato markdown
-Software sugerido: **Atom Text Editor**, un editor de código con control de versiones git integrado.
-[**Descarga e instrucciones de instalación**](https://flight-manual.atom.io/getting-started/sections/installing-atom/) +- ## git
+Un sistema de control de versiones para el seguimiento de los cambios que son implementados en las guías y traducciones mientras están siendo escritas.
+[**¿Qué es git?**](https://es.wikipedia.org/wiki/Git)
· [**Descarga e instrucciones de instalación**](https://git-scm.com/downloads) -### 02. Cuenta en una instancia de Gitea +- ## Un editor de texto con soporte para archivos con formato markdown
+_Software sugerido:_:
+· **VSCodium**, una versión gestionada por la comunidad con licencia libre del editor VS Code de Microsoft. [[**Descarga e intrucciones de instalación**](https://vscodium.com/)]
+· **Neovim**, un editor de texto hiperextensible basado en Vim. [[**Descarga e instrucciones de instalación**](https://github.com/neovim/neovim/wiki/Installing-Neovim)]
+· **Kate Editor**, un editor lleno de características. [[**Descarga e instrucciones de instalación**](https://kate-editor.org/es/get-it/)] + +
+ +## b. Una cuenta de Gitea Para poder enviar los cambios que realizas a las guías, ya sea traduciendo, editando o escribiéndolas, necesitas tener una cuenta en una instancia de **Gitea**. Para registrar una cuenta en la instancia donde están nuestros repositorios, ve [**aquí**](https://git.disroot.org/user/sign_up). -### 03. Solicitar acceso a nuestros repositorios +
+ +## c. Solicitar acceso a nuestro repositorio Para poder registrar cambios en los repositorios git de **Disroot**, necesitarás solicitar acceso. Esto se realiza desde la página de git de nuestro proyecto. -### 04. Configurar nombre de usuari@ y correo +
+ +## d. Configurar nombre de usuari@ y correo Esto es necesario para poder enviar tu trabajo desde tu máquina local al repositorio remoto. Para configurar el nombre de usuari@ de git y el correo - abre una terminal e inicia git
`git init`
- Tipea, y completa con tu información, los siguientes comandos:
-`git config --global user.email usuario@email`
+`git config --global user.email "usuario@email"`
`git config --global user.name "Tu nombre de usuario"` +
-## Crear / Traducir guías + +# 2. Creando / Traduciendo guías El proceso de creación o traducción de guías no es difícil y requiere solo un poco de práctica para aprender. +El procedimiento es bastante simple: + +1. Consigue una copia de los archivos sobre los que vas a trabajar; +2. trabaja localmente en tu computadora sobre los archivos, +3. y una vez que has terminado, envíalos. + Lo primero que hay que hacer es clonar el repositorio, esto significa hacer una copia local de los archivos remotos. Todo el trabajo será realizado sobre esta copia. -### Clonar el repositorio +
+ +## a. Clonar el repositorio Un repositorio git es una carpeta de proyecto que contiene los archivos creados o a ser traducidos y el registro histórico detallado de los cambios. Para clonar el repositorio, abre una terminal en el directorio donde te gustaría clonarlo. Una vez allí utilizarás el comando `git clone`, una instrucción para clonar un repositorio escribiendo su dirección. En nuestro caso sería: @@ -68,12 +88,16 @@ Para clonar el repositorio, abre una terminal en el directorio donde te gustarí Una vez que el repositorio ha sido copiado a nuestro disco duro, verás un directorio `howto` que contiene todos los archivos del proyecto. Luego se puede mover a cualquier lugar en tu computadora. -### Instrucciones para crear / traducir +
+ +## Instrucciones para crear / traducir Una vez que tengas copiado el repositorio en tu máquina, puedes comenzar a crear, editar y/o traducir siguiendo los pasos descritos en estas guías: -- [Cómo utilizar git para las guías de **Disroot**](https://howto.disroot.org/es/contribute/git/how-to-use-git)
+- [Cómo contribuir al proyecto Howto de **Disroot**](https://howto.disroot.org/es/contribute)
-- [Procedimiento de **Disroot** para traducciones](https://howto.disroot.org/es/contribute/translations_procedure) +- [Procedimiento para Guías y Traducciones](https://howto.disroot.org/es/contribute/procedure) -## Licencia +
+ +# 3. Licencia La documentación de **Disroot's Howto** está bajo una licencia [Atribución-CompartirIgual 4.0 Internacional de Creative Commons](https://creativecommons.org/licenses/by-sa/4.0/deed.es) diff --git a/disroot_h2_title.png b/disroot_h2_title.png deleted file mode 100644 index 6152acdd..00000000 Binary files a/disroot_h2_title.png and /dev/null differ diff --git a/h2.png b/h2.png new file mode 100644 index 00000000..073a50b5 Binary files /dev/null and b/h2.png differ