public/guilloche-generator
2
0
Fork 0
Code Pull Requests Activity

update readme with nix setup and disclaimer, increase scale max to 10

Browse Source
This commit is contained in:
Michael Czechowski
2025-09-22 15:35:04 +02:00
parent a0212a3355
commit 050273e51d
10 changed files with 1268 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -15,10 +15,21 @@
---
## Rquirements
## Requirements
- Node.js
- Node.js 10.24.1 (insecure EOL version, provided without warranty)
- Angular CLI
- Nix (for reproducible development environment)
## Development Setup
This project uses Nix for a reproducible development environment.
1. Enter the Nix shell: `nix-shell`
2. Install dependencies: `npm install`
3. Start development: `make start` or `npm run start`
**Disclaimer:** This software is provided without any warranty. Use at your own risk.
## NPM Scripts
@@ -30,9 +41,9 @@
## Development server
Download dependencies with `npm i` or `yarn`.
After entering the Nix shell, download dependencies with `npm install`.
Run `npm run start` for a dev server. Browser opens and navigates automatically to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
Run `make start` or `npm run start` for a dev server. Browser opens and navigates automatically to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Build