diff options
| author | eug-vs <eugene@eug-vs.xyz> | 2022-05-06 18:25:54 +0400 |
|---|---|---|
| committer | eug-vs <eugene@eug-vs.xyz> | 2022-05-06 18:25:54 +0400 |
| commit | c29168ba478e74e285e4230785af90deddfc396a (patch) | |
| tree | a909941e5d98372b73fc59695cd370cd67ee38f3 | |
| parent | ecd098a90dd2023a2aa68c8fb8f375a6f6470a9e (diff) | |
| download | chrono-cube-ui-c29168ba478e74e285e4230785af90deddfc396a.tar.gz | |
docs: update README
| -rw-r--r-- | README.md | 23 |
1 files changed, 2 insertions, 21 deletions
@@ -1,21 +1,2 @@ -# chrono-cube -Frontend part of ChronoCube web application - -a professional timer for speecubing with simple UI, scoreboard, guides and statistics analysis. - - -# Technologies stack -- [React.js](https://reactjs.org/) -- [Material UI components](https://material-ui.com/) - -# Getting started -To run the project, you should have [Node Package Manager](https://www.npmjs.com/) installed. It's also recommended to use -[Node Version Manager](https://github.com/nvm-sh/nvm). - -1. `npm i` (shorthand for `npm install`) - install project dependencies. -2. `npm start` - run the project. - -# Contribute -[Contribute to ChronoCube](https://github.com/users/Eug-VS/projects/3) - -Recommended IDE - [WebStorm](https://www.jetbrains.com/webstorm/). It's also preferable to install -`Styled Components & Styled JSX` plugin. +# chrono-cube-ui +Simple professional timer for speedcubing written in React with Typescript. |