diff --git a/.gitignore b/.gitignore index 911bc7bd5d55..8b64a9bffb85 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,12 @@ -node_modules -.next -npm-debug.log +# build output dist build + +# dependencies +node_modules + +# logs +npm-debug.log + +# other +.next diff --git a/History.md b/HISTORY.md similarity index 100% rename from History.md rename to HISTORY.md diff --git a/Readme.md b/README.md similarity index 96% rename from Readme.md rename to README.md index 9aec566d632f..2978133a296d 100644 --- a/Readme.md +++ b/README.md @@ -1,6 +1,6 @@ # hyperterm -## Developing +## Contribute To install `package.json` dependencies in a way where the native modules are built with `electron`, run: @@ -22,10 +22,10 @@ $ webpack --watch Then you can run: ```bash -$ electron index +$ npm start ``` -to launch the app! +...to launch the app! ## TODO diff --git a/package.json b/package.json index a35109bccc1d..cb754f4e2234 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "hyperterm", "productName": "HyperTerm", "version": "0.1.0", - "description": "", + "description": "HTML/JS/CSS Terminal", "dependencies": { "child_pty": "3.0.1", "default-shell": "1.0.1", @@ -37,7 +37,7 @@ } }, "scripts": { - "launch": "electron index", + "start": "electron index", "lint": "eslint *.js" } }