docs: scafolding

b0sc · Oct 14, 2024 · 24db8a4 · 24db8a4
1 parent 3182185
commit 24db8a4
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 1 deletion.
diff --git a/.nojekyll b/.nojekyll
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": false
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+# Guidelines
+
+- Make sure your editor supports formatting with [Prettier](https://prettier.io/docs/en/install), and format according to `.prettierrc` file before committing.
+- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
+- Use [GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow) for branching and use [Pull Request Template](./docs/pull_request_template.md) for pull requests.
diff --git a/README.md b/README.md
@@ -1 +1,45 @@
-# logic_sim
+<img align="right" width="300" src="./assets/look.png" alt="clone this repository" />
+
+# Logic Gates Simulator
+
+Provides a simple and intuitive way to create and simulate logic gates.
+
+## Features
+
+- [ ] Create and edit logic gates
+- [ ] Connect logic gates
+- [ ] Simulate logic gates
+
+# Demo
+
+Live Demo at [logicSim.bosc.org.np](https://logicsim.bosc.org.np)
+
+<!-- gif demo here when partly ready -->
+
+# Installation and Development
+
+Raw HTML, CSS, and JS are used to build this project. No build tools are used.
+
+```bash
+git clone [url]
+cd logicSim
+open index.html # or double click or drag and drop to browser
+```
+
+# Contributing
+
+Contributions are welcome. Please create an issue or pull request. View the [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
+
+# License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](./LICENSE) file for details.
+
+<!--
+references:
+https://github.com/jppellet/Logic-Circuit-Simulator (best but in ts, not static)
+
+https://github.com/drendog/Logic-Circuit-Simulator (static in js, not worthy)
+https://github.com/saliherdemk/Logic-Circuit-Simulator (static in js, not worthy)
+
+https://github.com/vassbo/logic (different but great, static, implementable)
+ -->
diff --git a/assets/look.png b/assets/look.png
diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md
@@ -0,0 +1,17 @@
+## Describe your changes
+
+## Context
+
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## Checklist before requesting a review
+
+- [ ] If it is a core feature, I have added thorough tests
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have only one commit (if not, squash them into one commit)
+- [ ] This PR is not a duplicate
+
+ <!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
diff --git a/index.html b/index.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>LogicSim</title>
+  </head>
+  <body>
+    <h1>Logic Gates Simulator</h1>
+    <h2>Under Construction!</h2>
+  </body>
+</html>