Skip to content

Commit

Permalink
fix: move english version up and add details tag (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
vcwild committed Oct 4, 2023
1 parent 3d7cb5a commit 2e9f65a
Showing 1 changed file with 83 additions and 81 deletions.
164 changes: 83 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,87 @@
<!-- Logo 4noobs -->
<details>
<summary>🇺🇸 English version</summary>

<p align="center">
<a href="https://github.com/he4rt/4noobs" target="_blank">
<img src="docs/.vuepress/public/images/header_4noobs.svg">
</a>
</p>

<!-- Title -->

<p align="center">
<h2 align="center">He4rt Developers QA Course</h2>

<h1 align="center">

<img src=".github/qa.gif" alt="QA Image" width="150">
</br>
<img src="https://img.shields.io/github/actions/workflow/status/vcwild/qa4noobs/build.yml?branch=main&style=flat-square&color=9468cc" alt="build" />
<img src="https://img.shields.io/badge/topics-42-9468cc?style=flat-square" alt="topics" />
<img src="https://img.shields.io/github/languages/code-size/vcwild/qa4noobs?color=9468cc&style=flat-square" alt="topics" />
<img src="https://img.shields.io/github/license/vcwild/qa4noobs?color=9468cc&style=flat-square" alt="license" />

</h1>

<h2 align="center">
<a href="https://vcwild.github.io/qa4noobs/" > <strong>View the full project »</strong></a>
</h2>
<br />
<p align="center">
<a href="#about">About</a> •
<a href="#ROADMAP">Roadmap •</a>
<a href="#contribute">Contribute</a> •
<a href="#author">Authors</a> •
<a href="#license">License</a>
</p>
</p>

<!-- ABOUT THE PROJECT -->

## ❓ About the Project <a id="about"></a>

Software quality is an area of knowledge that involves ensuring that a software product meets requirements, is reliable, efficient, and effective. Software quality is an attribute that can be assessed through testing, which aims to verify if a software product meets requirements and is free of defects.

This project aims to present the fundamentals of software testing, tools, and best practices for those starting in the field of software quality.

<!-- CONTRIBUTING -->

## 🤝 How to Contribute <a id="contribute"></a>

Contributions make the open-source community an amazing place to learn, inspire, and create. All contributions are **greatly appreciated**.

1. Fork the project.
2. Create a branch for your new feature (`git checkout -b feature/awesomeFeature`).
3. Commit your changes (`git commit -m 'Added awesome content'`).
4. Push to the branch (`git push origin feature/awesomeFeature`).
5. Open a Pull Request.

### Local Development <a id="development"></a>

To run the project locally, you need to have [Node.js](https://nodejs.org/en/) installed on your machine. We also recommend using [Yarn](https://yarnpkg.com/) as the package manager.

Add environment variables to your path:

```sh
source scripts/enviroment.sh
```
Run the following commands:
```sh
# Install dependencies
yarn

# Serve with hot reload at localhost:8080
yarn dev
```
### 💁‍♂️ Authors <a id="author"></a>

Victor Manoel - Software Quality Engineer - @Keeabo<br>
Victor Wildner - Software Quality Engineer - @vcwild

### 🏷️ License <a id="license"></a>
This project is licensed under the AGPL-3.0 License. See the [LICENSE](LICENSE) file for more details.
</details>

<p align="center">
<a href="https://github.com/he4rt/4noobs" target="_blank">
Expand Down Expand Up @@ -240,85 +323,4 @@ O projeto está sob a licença AGPL-3.0. Veja o arquivo [LICENSE](LICENSE) para

---

## English Documentation
<!-- Logo 4noobs -->

<p align="center">
<a href="https://github.com/he4rt/4noobs" target="_blank">
<img src="docs/.vuepress/public/images/header_4noobs.svg">
</a>
</p>

<!-- Title -->

<p align="center">
<h2 align="center">He4rt Developers QA Course</h2>

<h1 align="center">

<img src=".github/qa.gif" alt="QA Image" width="150">
</br>
<img src="https://img.shields.io/github/actions/workflow/status/vcwild/qa4noobs/build.yml?branch=main&style=flat-square&color=9468cc" alt="build" />
<img src="https://img.shields.io/badge/topics-42-9468cc?style=flat-square" alt="topics" />
<img src="https://img.shields.io/github/languages/code-size/vcwild/qa4noobs?color=9468cc&style=flat-square" alt="topics" />
<img src="https://img.shields.io/github/license/vcwild/qa4noobs?color=9468cc&style=flat-square" alt="license" />

</h1>

<h2 align="center">
<a href="https://vcwild.github.io/qa4noobs/" > <strong>View the full project »</strong></a>
</h2>
<br />
<p align="center">
<a href="#about">About</a> •
<a href="#ROADMAP">Roadmap •</a>
<a href="#contribute">Contribute</a> •
<a href="#author">Authors</a> •
<a href="#license">License</a>
</p>
</p>

<!-- ABOUT THE PROJECT -->

## ❓ About the Project <a id="about"></a>

Software quality is an area of knowledge that involves ensuring that a software product meets requirements, is reliable, efficient, and effective. Software quality is an attribute that can be assessed through testing, which aims to verify if a software product meets requirements and is free of defects.

This project aims to present the fundamentals of software testing, tools, and best practices for those starting in the field of software quality.

<!-- CONTRIBUTING -->

## 🤝 How to Contribute <a id="contribute"></a>

Contributions make the open-source community an amazing place to learn, inspire, and create. All contributions are **greatly appreciated**.

1. Fork the project.
2. Create a branch for your new feature (`git checkout -b feature/awesomeFeature`).
3. Commit your changes (`git commit -m 'Added awesome content'`).
4. Push to the branch (`git push origin feature/awesomeFeature`).
5. Open a Pull Request.

### Local Development <a id="development"></a>

To run the project locally, you need to have [Node.js](https://nodejs.org/en/) installed on your machine. We also recommend using [Yarn](https://yarnpkg.com/) as the package manager.

Add environment variables to your path:

```sh
source scripts/enviroment.sh
```
Run the following commands:
```sh
# Install dependencies
yarn

# Serve with hot reload at localhost:8080
yarn dev
```
### 💁‍♂️ Authors <a id="author"></a>

Victor Manoel - Software Quality Engineer - @Keeabo<br>
Victor Wildner - Software Quality Engineer - @vcwild

### 🏷️ License <a id="license"></a>
This project is licensed under the AGPL-3.0 License. See the [LICENSE](LICENSE) file for more details.

0 comments on commit 2e9f65a

Please sign in to comment.