Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
krikienoid committed Feb 19, 2023
1 parent 40a452f commit e0c3951
Showing 1 changed file with 8 additions and 14 deletions.
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,19 @@
[krikienoid.github.io/flagwaver](https://krikienoid.github.io/flagwaver/)

## Features
## Description

- Upload images from the web or from your device.
- Supports flag cloths with different aspect ratios.
- Set the hoist side and flag orientation.
- Try out different flagpoles.
- Adjust wind speed and direction.
- Progressive Web App support.
FlagWaver is a web app that lets you upload your own image and turn it into a flag. It is a visualization tool that simulates a waving flag in 3D. You can change the hoist direction, wind, background, and more.

See the [wiki](https://github.com/krikienoid/flagwaver/wiki) for details.

## Development

This project uses a Gulp-powered build system with these features:
This project uses a Gulp powered build system to manage tasks such as transpilation and minification. Code files from the ```src``` directory are compiled and output to the ```dist``` directory.

**Dev tools** - Gulp, Rollup, Babel, Terser, Sass, Autoprefixer, clean-css

- Sass compilation and prefixing
- Rollup JavaScript bundler
- Built-in BrowserSync server
- For production builds:
- CSS compression
- JavaScript compression
**Frontend:** - Preact, React Redux, Redux, Spectre.css, three.js

### Build

Expand Down

0 comments on commit e0c3951

Please sign in to comment.