aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKumar Priyansh <[email protected]>2018-11-13 12:37:00 +0530
committerGitHub <[email protected]>2018-11-13 12:37:00 +0530
commit2534a4d56b475d889a2aeb4e5c6c35540ee7f7e2 (patch)
tree0cbf049c1af76ceead4ad9967690860cfa3291ce
parent5216879601ab0f7bee68c567c7bf8c515ec92c2b (diff)
downloadaboutscreen-2534a4d56b475d889a2aeb4e5c6c35540ee7f7e2.tar.xz
aboutscreen-2534a4d56b475d889a2aeb4e5c6c35540ee7f7e2.zip
Update README.mdHEADmaster
-rw-r--r--README.md44
1 files changed, 43 insertions, 1 deletions
diff --git a/README.md b/README.md
index 71d8208..0500152 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,44 @@
# aboutscreen
-About Screen for BackSlash Linux
+
+
+
+**aboutscreen** is a desktop application built with Electron framwork that displays the "About the System" data for BackSlash Linux systems.
+
+
+
+This app can be used to display about screen on any Desktop OS.
+
+
+
+#### Screenshot
+
+![5bea77f7b1b89](https://i.loli.net/2018/11/13/5bea77f7b1b89.png)
+
+
+
+## Contributing
+
+Feel free to open an [issue](https://github.com/luciferreeves/aboutscreen/issues) about the application.
+
+
+
+## Building from Source
+
+Fork the repository and Install [NodeJS](https://www.nodejs.org) and run the following commands to check if it is working:
+
+```
+node -v
+npm -v
+```
+
+If everything is correct, you wil get version numbers for Node and NPM. Next, install the dependencies:
+
+```
+npm install
+```
+
+Finally, run the app
+
+```
+npm start
+```