README is a file that brings a little description about the whole project, which contains an introduction and explanation of this one. The kind of information that can be describe here is information requeried to understand the project and its structure or purpose. Then, we will give a template to create a README file for a new project.
Gif or Image Introduction
Is simple and can sound so easy and yes, It does, but the impact that a Gif or Image can produce is too big. The viewer acquire the needed information to get interested in the project. For example:
About the Project
Give a general description of the project brings a general view about the project as a product, for example:
"Lifebank is an EOSIO-based dapp that helps local communities create a virtuous circle of value exchange between three parties — eligible life donors, community donation centers, and participating local businesses (sponsors).
Lifebank is an initiative of EOS Costa Rica, a company that develops blockchain-based solutions to solve real-world problems. Lifebank is our entry to the Coding for Change challenge organized by leading blockchain company, Block.one."
Table of Contents
With a good view about the information structure can make the reader go to the specific needed information, so then give a good view of the information with a Table of Contents will make easier this process. For example:
Table of Contents
- Gif or Image Introduction
- About The Project
- Content Table
- Project Purpose
- Tech Stack
- Development Environment
- File Structure
- About Company
Describes the reason of why this was made, for example:
"We identified two main problems: a blood donation shortage and a local economic slowdown. Amid the COVID-19 outbreak, blood banks urgently need donors. People who are potential qualifying donors are prompted to stay home and isolate. As donations plummet and demand for blood and plasma increases, blood banks are experiencing a pronounced global shortage.
Moreover, the pandemic is impacting local economies due to a generalized lockdown. Small businesses that rely on the local community must think of ways to incentivize customers to buy as soon as restrictions are lifted."
Know what version of the project is, could helps others to debug problems, give it differents solutions or approaches, for this reason, is needed to specify the lastest version of the project, for example:
Evodex is ready for our first group of beta testers to try the next generation decentralized exchange for EOS
Currently evodex is still in beta pre-release v0.1.0-beta.xx
We release the production software version using github tags following Semver.
We also use the git commit messages to generate the project change log.
Using the yarn version command you can update the version of your package via the command line.
The purpose is to make the user know the main technology were needed to develop the project, so the user could understand the project with a new kind of view, for example, the information that could be given here is:
- React.js - React 16✨, React Router 5
- Rematch/core - Rematch a Redux Framework
- Material-ui/core - React components for faster and easier web development universal-authenticator-library - A library for allowing apps to easily use different auth providers
- Lint - ESlint
- Styles - Material-UI Theme (customizable)
Specify where were the project developed, in case someone else wants to make a contribution to the project progress, for example:
evodex.io is running on the EOS MainNet and is built from the master branch, our production branch.
jungle.evodex.io is running on the Jungle 3 TestNet and is built from the develop branch used for development, integration, and testing new features.
- Clone this repo using
git clone https://github.com/YOUR_PROJECT_NAME.git
- Move to the appropriate directory:
yarnin order to install dependencies. At this point you can run
yarn startto see the example app at http://localhost:3000.
Give the needed instruction to run the project locally, for example:
Clone the repository
git clone https://github.com/your_username_/Project-Name.git
Install yarn packages
Run the project
This could help the reader understand the organization inside the project, for example:
/ ├── public │ ├── index.html │ └── manifest.json ├── src │ ├── api │ ├── components │ ├── config │ ├── containers │ ├── models │ ├── routes │ ├── theme │ ├── utils │ ├── App.js │ ├── index.js │ └── store.js ├── .dockerignore ├── .gitignore ├── .env.example ├── .eslintrc ├── .prettierrc ├── Dockerfile ├── LICENSE ├── README.md ├── docker-compose.yml ├── nginx.conf └── package.json
MIT © EOS Costa Rica
If you want to make a contribution, please follow the next steps:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature)
- Commit your Changes (
git commit -m '<type>(<scope>): <subject>')
- Push to the Branch (
git push origin feature/AmazingFeature)
- Open a Pull Request
Please Read EOS Costa Rica's Open Source Contributing Guidelines for more information about programming conventions.
If you find a bug, please report big and small bugs by opening an issue
<link to issue project section>
List the people who work in the project.
About EOS Costa Rica
EOS Costa Rica is an independently-owned, self-funded, bare-metal Genesis block producer that provides stable and secure infrastructure for EOSIO blockchains. We support open source software for our community while offering enterprise blockchain development and custom smart contract development for our clients.