From b8ca03c697ce1bfb90d47ed6c678136c98cccae1 Mon Sep 17 00:00:00 2001 From: utarwyn Date: Thu, 2 May 2024 23:44:44 +0200 Subject: [PATCH] Update README.md --- README.md | 37 ++++++++++++++++--------------------- 1 file changed, 16 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 24062ea..6e8fdf8 100755 --- a/README.md +++ b/README.md @@ -1,27 +1,14 @@ -# EcoCode +# ecocode.io -This template should help get you started developing with Vue 3 in Vite. +ecoCode is a collective project aiming to reduce environmental footprint of software at the code level. The goal of the +project is to provide a list of static code analyzers to highlight code structures that may have a negative ecological +impact: energy and resources over-consumption, "fatware", shortening terminals' lifespan, etc. -## Recommended IDE Setup +This repository contains the source code of [ecocode.io](https://ecocode.io) developed with [Vue.js](https://vuejs.org). +Although our website has an ecological footprint, we strive to make it as light and optimized as possible. Don't +hesitate to suggest ideas and improvements on this aspect. -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). - -## Type Support for `.vue` Imports in TS - -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types. - -If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps: - -1. Disable the built-in TypeScript Extension - 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette - 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)` -2. Reload the VSCode window by running `Developer: Reload Window` from the command palette. - -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - -## Project Setup +## 🚀 Project Setup ```sh npm install @@ -38,3 +25,11 @@ npm run dev ```sh npm run build ``` + +## 🤝 Contribution + +check [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-contribution) + +## 🤓 Main contributors + +check [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-main-contributors)