forked from Disroot/Howto
inspired by 88050821e4
Added a README file...
Allahu'Akhbar! Allahu'Akhbar! Allahu'Akhbar!!! Signed-off-by: tfelypoc <jacquefresco@reactionary.software>
This commit is contained in:
parent
88050821e4
commit
6e016774ae
1 changed files with 39 additions and 39 deletions
78
README.md
78
README.md
|
@ -1,59 +1,59 @@
|
|||
![](disroot_h2_title.png)
|
||||
![]()
|
||||
|
||||
# Disroot's How-tos & Translations
|
||||
## Disroot's How+tos & Translations
|
||||
|
||||
| [Disroot Howtos](https://howto.disroot.org) | [Disroot Website](https://disroot.org) |
|
||||
| [Disroot Howtos](http://howto.disroot.org) | [Disroot Website](http://disroot.org) |
|
||||
|
||||
----
|
||||
This repository contains the **Disroot's Howto Project** files and the information to create, modify and translate those files.
|
||||
++++
|
||||
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.
|
||||
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
|
||||
- Gitlab account
|
||||
- Request access to our repository
|
||||
- Setting your username and email
|
||||
* [Creating / Translating Howto's](#creating-translating-howtos)
|
||||
- Cloning the repository
|
||||
- Creating / Translating instructions
|
||||
+ Software required
|
||||
+ orgejo 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
|
||||
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:
|
||||
First of all, you need to have installed the following software.
|
||||
- **git**<br>
|
||||
A version control system for tracking the changes that are implemented to the howtos and translations as they're being written.<br>
|
||||
[**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)
|
||||
First of all, you need following software:
|
||||
+ __hg/git__<br>
|
||||
[__Disroot's Howto__](http://howto.disroot.org/en/)
|
||||
|
||||
- A text editor with markdown format files support<br>
|
||||
Suggested software: **Atom Text Editor**, a source code editor with git version control integrated.<br>
|
||||
[**Download & installation instructions**](https://flight-manual.atom.io/getting-started/sections/installing-atom/)
|
||||
+ A text editor with markdown format files support<br>
|
||||
Suggested software: __Sublime MERGE__, just another editor,<br>
|
||||
[__Download & install__](http://www.sublimemerge.com/download)<br>
|
||||
[_buy_](http://www.sublimehq.com/store/merge)
|
||||
|
||||
### 02. Gitlab account
|
||||
In order to send changes you make to the howtos, whether translating, editing, or writing them, you need to have an account in the Gitlab instance we use.
|
||||
### 02. orgejo 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 __orgejo__ instance.
|
||||
|
||||
To register an account at **India's FOSS Community**, where our repository is, go [**here**](https://git.fosscommunity.in/users/sign_in)
|
||||
To register an account at the instance where our repository is, go [__here__](http://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
|
||||
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
|
||||
This is necessary to be able to send your work from your machine to the remote repository. To setup the git username and email
|
||||
### 03. Fork euu
|
||||
read line this completely first > [click this repo][3] >> move mouse to top right corner >> click the icon, most right side icon ?>> __yes__, click Fork repo button
|
||||
|
||||
- open a terminal and start git<br>
|
||||
`git init`<br>
|
||||
|
||||
- type and complete with your information the following commands:<br>
|
||||
`git config --global user.email user@email`<br>
|
||||
`git config --global user.name "User Name"`
|
||||
[3]: http://git.disroot.org/Disroot/Howto
|
||||
|
||||
### 04. Setting your username & email
|
||||
summary > click email >> (do change email here) >> apply local or ... >>> Apply
|
||||
|
||||
<!--
|
||||
## Creating / Translating Howto's
|
||||
The process of creating or translating howtos is not difficult and requires only a bit of practice to learn.
|
||||
|
||||
|
@ -64,16 +64,16 @@ A git repository is a project folder containing the files created or to be trans
|
|||
|
||||
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:
|
||||
|
||||
`git clone https://git.fosscommunity.in/disroot/howto`
|
||||
`git clone http://git.disroot.org/Disroot/howto`
|
||||
|
||||
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
|
||||
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)<br>
|
||||
+ [Howto use git for __Disroot__'s Howtos](http://howto.disroot.org/en/contribute/git/how+to+use+git)<br>
|
||||
|
||||
- [**Disroot**'s Translation procedure](https://howto.disroot.org/en/contribute/translations_procedure)
|
||||
|
||||
## 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/)
|
||||
+ [__Disroot__'s Translation procedure](http://howto.disroot.org/en/contribute/translations_procedure)
|
||||
-->
|
||||
##### License
|
||||
The __Disroot's Howto__ documentation is licensed under a [Creative Commons Attribution+ShareAlike 4.0 International License](http://creativecommons.org/licenses/by+sa/4.0/)
|
||||
|
|
Loading…
Reference in a new issue