Add a README

[renatobmps]

• Create two documents and both starts with link to each other
  • Title and Introduction (en)
  • Title and Introduction (pt)
  • Technologies Used (en)
  • Technologies Used (pt)
  • Launch Instructions (en)
  • Launch Instructions (pt)
  • Scope of Functionalities (en)
  • Scope of Functionalities (pt)
  • Examples of Use (en)
  • Examples of Use (pt)
  • Project Status (en)
  • Project Status (pt)
  • Sources (en)
  • Sources (pt)
  • Contribution Guidelines (en)
  • Contribution Guidelines (pt)
  • License Information (en)
  • License Information (pt)
  • Author Information (en)
  • Author Information (pt)
• Create indices

I asked help by a prompt to know about good things to put on that and I'll comment about it to have a definition

Creating a README file for your GitHub project involves several key steps. Here's a comprehensive guide on what you should include in your README file:

1. Title and Introduction: Start with a clear title that explains what your project is about. This is usually the project's name and is denoted by a H1 heading (#). Follow this with an introduction that briefly describes the aim of the project and the problems it solves. If it's a training project, mention your motivation for creating it 1, 2.
2. Technologies Used: List the technologies used in your project and provide links to further information related to these technologies 2.
3. Launch Instructions: Provide instructions on how to run the project. If the project has specific hardware requirements, mention them here 1.
4. Scope of Functionalities: Describe the main features of your project. This isn't always necessary for smaller projects, but for larger ones, it helps users understand what they can expect 1.
5. Examples of Use: If your project is reusable code or a library, consider including examples of how to use it. This can be done as a code snippet within the README 1.
6. Project Status: If your project is still in development, mention any planned changes, the direction of development, or indicate that the project is complete 1, 2.
7. Sources: If your project was based on a tutorial or inspired by a task, mention this information 1.
8. Contribution Guidelines: If your project is open source and you welcome contributions, provide guidelines on how to contribute. This could include how to report issues, propose changes, and submit pull requests 2.
9. License Information: Include information about the license under which the code is released. This informs users about their rights and obligations when using or modifying your code 1.
10. Author Information: Finally, provide information about the author, including contact details and links to social media profiles 1.

Remember to keep your README clear and legible. Good documentation makes your repository attractive to potential users and contributors.

Phind

[renatobmps]

Considering the game will be made by brazilian players, it needs a english and portuguese version

[renatobmps]

Title and Introduction

What's this project?

This project is a JavaScript full-stack project for a game, a hangman game.

What's a hangman game?

Hangman is a popular word-guessing game where the player needs to guess the secret word. In each session, the player should suggest a letter. If the word contains it, the letter's position will be revealed and fielded with that letter, and if not, the hangman will receive a body part. If the completed hangman is made, the player is hanged, and that game will be considered lost, but if the player guesses the entire word before it, it'll gain a point. When the game is finished with a win or a loss, a new word will be drawn, and a new game will start.

Why did I do it?

Well, this is a training project. I made the first version using only HTML, CSS, and basic JavaScript. In the first version, when the main page was loaded, the JavaScript created a list of words and checked the local storage to know if some game had ended, and if it was true, removed the played words. A draw word was generated, and the CSS hides the letters. When the player guesses a word, the CSS sets it as visible. When all the words were discovered, they were saved to local storage, and the page was reloaded to start a new game. There is no backend or login service, just a simple use of localStorage.

As I learned more about web development, the project gained more features and became more difficult to handle. Now, it has a simple login service, data persistence, and will have a manage screen for admins soon.

Why a hangman game?

I like this game so much, and since it is a word game, the game can be easily programmed. The UI can be simple, and the backend process is programmatic. I can improve my logic without thinking about massive design stuff or Y and X positions, so it's perfect for me.

[renatobmps]

[rascunho]

Título e Introdução

O que é este projeto?

Este projeto é um projeto full-stack em JavaScript para um jogo, um jogo de forca.

O que é um jogo de forca?

O Jogo da Forca é um conhecido jogo de palavras, onde há uma palavra, ou frase escondida e o objetivo do jogador é decifrá-la. Há também uma dica para ajudá-lo. A cada jogada, o jogador deve sugerir uma letra para que ela seja avaliada, se ela existe na palavra, todas as suas posições serão reveladas, senão, a forca irá receber uma parte do enforcado. Caso a forca receba o corpo completo, o jogador é enforcado e perde, mas se o segredo for revelado, o jogador ganha um novo ponto. Ganhando ou perdendo, um novo jogo começa em seguida.

Por que eu o fiz?

Bem, este é um projeto de treinamento. Fiz a primeira versão usando apenas HTML, CSS e JavaScript básico. Na primeira versão, quando a página principal era carregada, o JavaScript criava uma lista de palavras e verificava o armazenamento local para saber se algum jogo havia terminado, e se era verdade, removia as palavras jogadas. Uma palavra sorteada era gerada, e o CSS ocultava as letras. Quando o jogador adivinhava uma palavra, o CSS a configurava como visível. Quando todas as palavras eram descobertas, elas eram salvas no armazenamento local, e a página era recarregada para começar um novo jogo. Não há back-end ou serviço de login, apenas um uso simples do localStorage.

Conforme eu aprendia mais sobre desenvolvimento web, o projeto ganhava mais recursos e se tornava mais difícil de lidar. Agora, ele tem um simples serviço de login, persistência de dados, e terá uma tela de gerenciamento para administradores em breve.

Por que um jogo de forca?
Eu gosto muito deste jogo, e como é um jogo de palavras, o jogo pode ser facilmente programado. A interface do usuário pode ser simples, e o processo de back-end é programático. Eu posso melhorar minha lógica sem pensar em coisas de design massivo ou posições Y e X, então é perfeito para mim.