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

(fix #684): Fixed all the typos and grammatical errors. #685

Open
wants to merge 1 commit 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions contributing_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ The revision history is presented in the following table

### Purpose of the guidelines

These guidelines are inteded to guide those who wish to contribute to this Interactive Book. It (tries) to cover most aspects such as the process workflow, license, style, quality, templates and tools.
These guidelines are intended to guide those who wish to contribute to this Interactive Book. It (tries) to cover most aspects such as the process workflow, license, style, quality, templates and tools.


### Acknowledgements
### Acknowledgments

These guidlines are heavily based on the [Linux Document Project Author Guide](https://tldp.org/LDP/LDP-Author-Guide/html/index.html) and the Wikibooks [Contributing help](https://en.wikibooks.org/wiki/Help:Contributing) and [Policies and guidelines](https://en.wikibooks.org/wiki/Wikibooks:Policies_and_guidelines).
These guidelines are heavily based on the [Linux Document Project Author Guide](https://tldp.org/LDP/LDP-Author-Guide/html/index.html) and the Wikibooks [Contributing help](https://en.wikibooks.org/wiki/Help:Contributing) and [Policies and guidelines](https://en.wikibooks.org/wiki/Wikibooks:Policies_and_guidelines).

- The LDP Author Guide is Copyright (C) 1999-2002 Mark F. Komarinski, David C. Merrill, Jorge Godoy. It is licensed under the GNU FDL v1.1+ (no invariant sections, no front-cover texts and no-back-cover texts)
- Wikibooks documents are licensed under the [CC-by-sa](https://en.wikibooks.org/wiki/Wikibooks:Creative_Commons_Attribution-ShareAlike_3.0_Unported_License) License and copyrighted by contributors to Wikibooks
Expand Down Expand Up @@ -101,7 +101,7 @@ The proposal should clearly indicate what kind of contribution are you planning

Then, include a brief summary of the contribution content followed by the justification why it is needed.

Finaly, submit your proposal to the CircuitVerse Interactive Book coordination team, and discuss the proposal with them in order to refine it. The coordination team will either approve or reject the proposal. In case of rejection, comments will be included explaining why it was rejected, and how could it be improved when the proposed content is useful, but the proposed "format" whas not adequate enough.
Finally, submit your proposal to the CircuitVerse Interactive Book coordination team, and discuss the proposal with them in order to refine it. The coordination team will either approve or reject the proposal. In case of rejection, comments will be included explaining why it was rejected, and how could it be improved when the proposed content is useful, but the proposed "format" was not adequate enough.

---

Expand All @@ -117,7 +117,7 @@ If the original author cannot be contacted after a "good-faith" effort, fall bac

## Writing content

All content should be supported by valid sources. Please, research carefuly and validate all your references. Check that there are no copyright or license issues regarding the use of each of your sources.
All content should be supported by valid sources. Please, research carefully and validate all your references. Check that there are no copyright or license issues regarding the use of each of your sources.

When using online resources, make a "hard-copy" (screen-capture, pdf-printed version) of them to avoid missing resources in the future (Error 404)

Expand All @@ -128,7 +128,7 @@ To keep the consistency of the book, please follow the style indicated in these

### Quality assurance

Besides researching and validating your sources and adhering to the Interactive Book style, please also edit (remove unnecesary content) and check for spelling and grammar errors. Then, forward your contribution to a third party for proofreading. When you are satisfied with the quality and accuracy of your contribution ask for peer reviewers from the CircuitVerse community. Finally, submit your work to the "formal" review by creating a pull-request of your forked repository
Besides researching and validating your sources and adhering to the Interactive Book style, please also edit (remove unnecessary content) and check for spelling and grammar errors. Then, forward your contribution to a third party for proofreading. When you are satisfied with the quality and accuracy of your contribution ask for peer reviewers from the CircuitVerse community. Finally, submit your work to the "formal" review by creating a pull-request of your forked repository.

---

Expand Down Expand Up @@ -395,7 +395,7 @@ The CircuitVerse Interactive Book's sources are hosted in a GitHub repository. B

The Interactive Book is rendered using the Jekyll Static Site Generator (SSG). The GitHub repository is able to create a live version of the book using the continuous integration (CI) / continuous deployment (CD) workflows.

To work locally, you will need to setup a Jekyll development environment. It is posible to setup Jekyll natively for your OS or run it in a docker container.
To work locally, you will need to setup a Jekyll development environment. It is possible to setup Jekyll natively for your OS or run it in a docker container.

1. Workflow with native Jekyll

Expand Down
2 changes: 1 addition & 1 deletion docs/binary-algebra/ieee-std-754.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ A part of the binary number is used to store the *significand* (including a sign

## The IEEE 754 Standard

There are multiple ways of implementenig floating point numbers and arithmetics. However, since 1985 the IEEE Standard for Floating-Point Arithmetic (IEEE 754) has been available addressing many issues and providing a reliable and portable definition.
There are multiple ways of implementing floating point numbers and arithmetics. However, since 1985 the IEEE Standard for Floating-Point Arithmetic (IEEE 754) has been available addressing many issues and providing a reliable and portable definition.

The latest version of the standard was published in 2019 {% cite ieee754std2019 --file books %} and the latest ISO version (identical to the IEEE Std 754) was published in 2020 {% cite iso60559 --file books %}

Expand Down
2 changes: 1 addition & 1 deletion docs/binary-algebra/subtraction.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ has_children: false

## Subtraction

Binary subtraction is also a simple task. You just need to keep in mind i.e., whenever 0 takes borrow, it becomes 10 i.e., 2 in decimal. In case number to the left is zero then look for the number more left to that until you find 1. In case nothing is present to borrow then that number becomes negative. Also, the number which gives borrow is reduced by 1.
Binary subtraction is also a simple task. You just need to keep in mind i.e., whenever 0 takes borrow, it becomes 10 i.e., 2 in decimal. In case the number to the left is zero then look for the number further left until you find 1. In case nothing is present to borrow then that number becomes negative. Also, the number which gives borrow is reduced by 1.

***Note: 10 becomes 1 after giving borrow.***

Expand Down
2 changes: 1 addition & 1 deletion docs/binary-representation/binary-numbers.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Let's tell you something more about conversion. Conversion from Binary to Decima
- **STEP 3:** Add 'em all.
- **STEP 4:** Result is ready :)

***Note: If the number is large, increase bits of the binary number on the left. Keep in mind that it's value will increase subsequently.***
***Note: If the number is large, increase bits of the binary number on the left. Keep in mind that its value will increase subsequently.***

```yaml
Example ::
Expand Down
2 changes: 1 addition & 1 deletion docs/binary-representation/discrete-quantities.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ has_children: false

- Section 1.1 "Analog and Discrete Variables" in {% cite donzellini2018introduction --file books %}
- Section "Analogue and digital data" (Chapter 1) in {% cite stonham2017digital --file books %}
- Secion "Digital and analogue signals" (Chapter 1) in {% cite morris2013digital --file books %}
- Section "Digital and analogue signals" (Chapter 1) in {% cite morris2013digital --file books %}
- Chapter 1 "Introduction: Analog Versus Digital" in {% cite lameres2019introduction --file books %}


Expand Down
2 changes: 1 addition & 1 deletion docs/binary-representation/encoding-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ has_children: false
The new Interactive Book for digital logic design requires you to study [binary ](https://learn.circuitverse.org/docs/binary.html) and its uses.
In computing, a <em>flag</em> is a type of signal usually used to indicate whether something is true or false. To save time and make your program less complicated, you might want to combine these flags and send several pieces of information in one go.

Imagine you wanted to send a message to your friend to indicate which subjects had set homework on a particular day. If it was only one subject, you can just send the name of the subect - e.g. English - but if there is more than one, it gets more complicated. One way to do it is to give each subject a number:
Imagine you wanted to send a message to your friend to indicate which subjects had set homework on a particular day. If it was only one subject, you can just send the name of the subject - e.g. English - but if there is more than one, it gets more complicated. One way to do it is to give each subject a number:

| Serial no. | Subject |
|:------------:|:------------:|
Expand Down
6 changes: 3 additions & 3 deletions docs/comb-lsi/alu.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ Now you can take up the 1 bit ALU as block and construct a 4 bit ALU, which perf
There are a few important takeaways here:
- The selection lines MO and M1 select the function ALU performs. These selection lines combined with the input arguments and desired functions, an Instruction Set can be formed.
- These Instructions can used to create meaningful programs. Since these are required to be easily available, they can be stored on ROM unit.
- The input arguments A and B are often stored in Internal Registers. These along with other special purpose register form the registers of the microcontroller.
- The input arguments A and B are often stored in Internal Registers. These along with other special purpose registers form the registers of the microcontroller.
- ROM memories are slower in speed, hence an intermediate high speed RAM is often used.
- All the critical timings, decoding of the instructions are often grouped together in seperate control and timings unit.
- All the critical timings, and decoding of the instructions are often grouped together in separate control and timings unit.
- If a Micro controller would be constructed only from ALU, RAM and ROM, there would not be any external interface. Hence, you now have Input/Output (I/O) ports.
- Additional features such as Interrupts, communication protocols, EEPROM, Timers/Counters, Debug interfaces etc. are incorporated to make a controller complete.

In above discussion you might have left out intricate details involved in an ALU, CPU design. But the aim was to understand ALU/CPU at a deeper level.
In the above discussion you might have left out intricate details involved in an ALU, CPU design. But the aim was to understand ALU/CPU at a deeper level.

<style>
img{
Expand Down
2 changes: 1 addition & 1 deletion docs/comb-ssi/logic-families.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ has_children: false

## Technologies behind logic integrated circuits

There are many technologies available to implement digital logic components which work according to the Boolean algebra's laws and rules. The most common technologies are known as TTL and CMOS logic families, however many variations exist. Each technology presents unique features such as propagation time, power requirements, logic levels, heat dissipation among others. Also, its packaging requires careful consideration when implementing an actual circuit.
There are many technologies available to implement digital logic components which work according to the Boolean algebra's laws and rules. The most common technologies are known as TTL and CMOS logic families, however many variations exist. Each technology presents unique features such as propagation time, power requirements, logic levels, and heat dissipation among others. Also, its packaging requires careful consideration when implementing an actual circuit.

A full description of logic families can be found in the following resources:

Expand Down
2 changes: 1 addition & 1 deletion docs/logic-design/canonical.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Similarly, when the POS form of a Boolean expression is in canonical form, then

## Conversion of canonical forms

You can represent the one canonical formed equation in other canonical form i.e. you can represent the SOP form of equation in POS form and POS form equation in SOP form. To convert the canonical equations, you interchange the Σ and Π symbols after listing out the index numbers of the equations, which are excluded from the original form of equation.
You can represent the one canonical formed equation in another canonical form i.e. you can represent the SOP form of equation in POS form and POS form equation in SOP form. To convert the canonical equations, you interchange the Σ and Π symbols after listing out the index numbers of the equations, which are excluded from the original form of equation.

The important thing to remember about Boolean functions is that, **the SOP and POS forms are Duals to each other**. There are 2 steps to follow to convert the canonical form of the equations. They are:-

Expand Down
2 changes: 1 addition & 1 deletion docs/logic-design/functional-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This combinational circuit has ‘n’ input variables and ‘m’ outputs. Each

## Design procedure of combinational circuits

1. Find the required number of input variables and outputs from given specifications.
1. Find the required number of input variables and outputs from the given specifications.
1. Formulate the Truth table. If there are ‘n’ input variables, then there will be 2n possible combinations. For each combination of input, find the output values.
1. Find the Boolean expressions for each output. If necessary, simplify those expressions.
1. Implement the above Boolean expressions corresponding to each output by using Logic gates.
Expand Down
2 changes: 1 addition & 1 deletion docs/logic-design/kmaps.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For example, display the following 2 variable Karnaugh Map:

![](/assets/images/map11.png)

You have bounded to the vertical axis, the variable `A`, and enumerate through the possible values for `A` (being `{0, 1}`). Similarly, perform a similar operation for the `B` variable. Since you are using a 2 variable expression, you can bound one variable to each axis and the visualization works fine in a `2x2` matrix.
You have bounded to the vertical axis, the variable `A`, and enumerate through the possible values for `A` (being `{0, 1}`). Similarly, perform a similar operation for the `B` variable. Since you are using a 2 variable expression, you can bind one variable to each axis and the visualization works fine in a `2x2` matrix.

Let's instead look at a more involved example with 4 variables:

Expand Down
2 changes: 1 addition & 1 deletion docs/logic-design/mev.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ A method of MEV minimization based on partial variables is described in:
- Section "Minimizing MEV maps" in {% cite stonham2017digital --file books %}
- Section "Map-entered variables" in {% cite kohavi2010switching --file books %}

Another recursive method which can be used when the MEV only has expessions of one variable (or its complement) is described next.
Another recursive method which can be used when the MEV only has expressions of one variable (or its complement) is described next.

The expressions found in the map's cells can have these forms:

Expand Down
10 changes: 5 additions & 5 deletions docs/seq-design/mds.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ More information about MDS diagrams can be found in the book *An Engineering App

## Large scale digital system design

For complex digital logic system with a large number of inputs, the following design methodology, from the point of view of a system controller, can be used:
For a complex digital logic system with a large number of inputs, the following design methodology, from the point of view of a system controller, can be used:

1. State main definitions and specifications of the problem/system
1. State the main definitions and specifications of the problem/system
2. Define basic operations, limits and restrictions.
1. Draw a basic (simplified) block diagram
2. Draw a simplified (general) flowchart diagram
3. Define the system **timing** requirement
1. Draw a general time diagram
4. Detail the controller's sequential behaviour
1. Draw detailed time diagram
2. Draw detailed flowchart diagram
3. Draw detailed block diagram
1. Draw a detailed time diagram
2. Draw a detailed flowchart diagram
3. Draw the detailed block diagram
5. Draw MDS diagram
6. Choose the controller architecture: SSI (logic gates and flip-flops), MSI (based on MUXs, &#x2026;) or LSI (ROM based, &#x2026;)
7. Asign state codes
Expand Down
Loading