diff --git a/README.md b/README.md index 6a24b14..ee59e1a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ +

The CircuitVerse logo +

# CircuitVerse Documentation This is the official documentation of the CircuitVerse simulator. This is meant to be a guide for users to use CircuitVerse. This contains the details of the usage of all Circuit Elements in CircuitVerse along with some tips and tricks. This guide assumes that the user has the minimum required knowledge. -**Note :** **This is not a documentation on digital logic design. If you are interested in that, please checkout the GSoC'20 link at the end** +**Note :** **This is not a documentation on digital logic design. If you are interested in that, please checkout the GSoC'20 link at the end!** ## Cloning Instructions -> **Note :** If you want to contribute, first fork the original repository and clone the forked repository into your local machine followed by `cd` into the directory +> **Note :** If you want to contribute, first fork the original repository and clone the forked repository into your local machine followed by `cd` into the directory. ```sh git clone https://github.com//CircuitVerseDocs.git @@ -28,20 +30,20 @@ When you add a page, make sure you have an entry in the `_sidebar.md` **Note :** **All the documentation should have a corresponding live circuit embedded so as to help the users. Also, the live circuit is NOT the same as image of a circuit.** ## Installation on Netlify -1. Go to [https://app.netlify.com](https://app.netlify.com) and register an account -2. Click `New site from Git` or go to [https://app.netlify.com/start](https://app.netlify.com/start) +1. Go to [https://app.netlify.com](https://app.netlify.com) and register an account. +2. Click `New site from Git` or go to [https://app.netlify.com/start](https://app.netlify.com/start). 3. Click `GitHub` and authorise Netlify to view all your repositories or just the repository that you would like to publish - * You will need to be the owner of the repository as Netlify needs to add a webhook and deploy key. You can get around this by forking the repository and publishing that instead -4. Click `Deploy site` (you do not need to change any settings other than maybe `branch`) + * You will need to be the owner of the repository as Netlify needs to add a webhook and deploy key. You can get around this by forking the repository and publishing that instead. +4. Click `Deploy site` (you do not need to change any settings other than maybe `branch`). ## Steps for Contributing -1. Fork this project +1. Fork this project. 2. Clone **your** version of repository locally. -3. Create your feature branch `(git checkout -b feature/feature_name)` -4. Commit your changes `(git commit -am 'Add feature')` -5. Push to the branch `(git push origin feature_name)` -6. Create a new Pull Request +3. Create your feature branch `(git checkout -b feature/feature_name)`. +4. Commit your changes `(git commit -am 'Add feature')`. +5. Push to the branch `(git push origin feature_name)`. +6. Create a new Pull Request. ## Prerequisites for using the CircuitVerse Simulator @@ -60,8 +62,8 @@ Read the [Code of Conduct](./code-of-conduct.md) of our [CircuitVerse](https://c ## GSoC'20 Project Details -### Interactive Book +### Interactive Book - -The primary goal is to develop an opensource book which teaches digital logic design. This means that professors and students all over the world should read and contribute to the same. The book should make little assumptions about the knowledge of the reader. +The primary goal is to develop an opensource book which teaches digital logic design. This means that professors and students all over the world could read and contribute to the same. The book should make little assumptions about the knowledge of the reader. Read the [wiki](https://github.com/CircuitVerse/CircuitVerseDocs/wiki/Interactive-Book) for more information on the interactive book. diff --git a/code-of-conduct.md b/code-of-conduct.md index 1863055..2c81042 100644 --- a/code-of-conduct.md +++ b/code-of-conduct.md @@ -18,7 +18,7 @@ Diversity and inclusion make the CircuitVerse community strong. We encourage par ## Unacceptable Behaviour Harassment may include but not limited to the following: -- Offensive, inappropriate, or unwanted comments related to gender, gender identity or expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, national origin, religion, or age, or other protected categories under applicable law. +- Offensive, inappropriate, or unwanted comments related to gender, gender identity or expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, national origin, religion, or age, or other protected categories under applicable law - Visual harassment eg. sexual imagery or use of sexual language at Docker community events - Disrespect towards differences of opinion - Deliberate intimidation, stalking, harassing photography or recording @@ -32,7 +32,7 @@ Harassment may include but not limited to the following: - If you are the subject of, or witness to any violations of this Code of Conduct, inform us @ . - The project lead’s word is final. If the community chooses to question the wisdom of the actions of a committer, the project lead can review their decisions, and either uphold or reverse them. -Portions derived from the [Slack Developer Community Code of Conduct][1], [The Ada Initiative][2], [geekfeminism.org][3], [Drupal Events][4], and [Code of Conduct Contributor Covenant][6] +Portions derived from the [Slack Developer Community Code of Conduct][1], [The Ada Initiative][2], [geekfeminism.org][3], [Drupal Events][4], and [Code of Conduct Contributor Covenant][6]. This work is licensed under the [MIT License][5].