Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README.md #2

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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

*~
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}