diff --git a/.gitignore b/.gitignore index 26221a2..313b39c 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,11 @@ deps/codemirror/mode/* !deps/codemirror/mode/meta.js !deps/codemirror/mode/javascript +#npx vite build +dist/ + +node_modules/ + +package-lock.json + *~ diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e22a7e --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +QUICK START + +Prepare qmlweb repository: + +1. git clone --recurse-submodules https://github.com/qmlweb/qmlweb.git +2. cd qmlweb (go to qmlweb dir) +3. npm install (install qmlweb dependencies) +4. npm link (link qmlweb repository as local npm library) + +Prepare qmlweb.github.io repository: + +5. cd .. (leave qmlweb repository) +6. git clone --recurse-submodules https://github.com/qmlweb/qmlweb.github.io.git (clone qmlweb webpage repository) +7. npm link qmlweb +8. npm install (install dependencies) +9. npx vite (this run webserwer, open browser and go to http://localhost:5173/ , qmlweb.github.io page shoud appear) +10. npx vite build (build page, page will be build in ./dist folder) + \ No newline at end of file diff --git a/package.json b/package.json index 38f4991..7eeda86 100644 --- a/package.json +++ b/package.json @@ -15,5 +15,8 @@ "bugs": { "url": "https://github.com/qmlweb/qmlweb.github.io/issues" }, - "homepage": "https://github.com/qmlweb/qmlweb.github.io#readme" + "homepage": "https://github.com/qmlweb/qmlweb.github.io#readme", + "devDependencies": { + "vite": "^5.1.3" + } }