add readme

This commit is contained in:
Bixilon 2021-05-13 13:24:14 +02:00
parent bf46558b6d
commit dd4d71cc25
No known key found for this signature in database
GPG Key ID: 5CAD791931B09AC4
3 changed files with 11 additions and 20 deletions

2
.gitignore vendored
View File

@ -44,3 +44,5 @@ testem.log
# System Files # System Files
.DS_Store .DS_Store
Thumbs.db Thumbs.db
*.iml

View File

@ -1,27 +1,16 @@
# Pixlyzer Vitrine # Pixlyzer Vitrine
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.2.12. (This is my first angular project, please don't blame me;)
## Development server This project is visualizing the data generated by [PixLyzer](https://gitlab.bixilon.de/bixilon/pixlyzer). It is wip and things may change over time.
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. ## Screenshots
## Code scaffolding ![](./doc/biomes.png)
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. ## Planend things
## Build - Visualizing all data
- Version selection (also reading own json files, etc)
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. - Diff tool
- Hosted version
## Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

BIN
doc/biomes.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB