Expand high-level documentation

This commit is contained in:
JC Staudt 2018-10-15 09:09:37 -07:00
parent 8e5b9c9be0
commit 35b287a405
4 changed files with 57 additions and 27 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

@ -19,7 +19,7 @@ Description | Images
| Right speaker | ![Right speaker 1](../images/TERES-I/hardware/020.jpg) ![Right speaker 2](../images/TERES-I/hardware/021.jpg)
| Transparent LED pipe | ![LED Pipe 1](../images/TERES-I/hardware/022.jpg) ![LED Pipe 2](../images/TERES-I/hardware/023.jpg)
| Set of screws: M2x1.5 mm 4 pcs; M2x3 mm 9 pcs; M2x4 mm 17 pcs; M2x5 mm 12 pcs | ![Screws 1](../images/TERES-I/hardware/024.jpg) ![Screws 2](../images/TERES-I/hardware/025.jpg)
| LCD 11.6”. It has protective foil on top. [Datasheet](../datasheets/TERES-015-LCD11.6/N116BGE-EA2.pdf) | ![LCD 1](../images/TERES-I/hardware/026.jpg) ![LCD 2](../images/TERES-I/hardware/027.jpg)
| [eDP](https://www.embedded.com/design/system-integration/4441940/eDP--A-better-embedded-display-ecosystem) 11.6" HD (1366x768) LCD. It has protective foil on top. [Datasheet](../datasheets/TERES-015-LCD11.6/N116BGE-EA2.pdf) | ![LCD 1](../images/TERES-I/hardware/026.jpg) ![LCD 2](../images/TERES-I/hardware/027.jpg)
| Left and right hinges | ![Hinges 1](../images/TERES-I/hardware/028.jpg) ![Hinges 2](../images/TERES-I/hardware/029.jpg)
| Mat set. There are four rubber pads for the bottom of the laptop, two circular pads for LCD frame screws cover and four self adhesive mats for holding the battery. | ![Mat 1](../images/TERES-I/hardware/030.jpg) ![Mat 2](../images/TERES-I/hardware/031.jpg)
| Magnet for the lid close sensor | ![Magnet 1](../images/TERES-I/hardware/032.jpg) ![Magnet 2](../images/TERES-I/hardware/033.jpg)

@ -1,3 +1,19 @@
# Why create an open-source, modular laptop?
- Laptop break or become obsolete every few years, as new software requires more processing power or memory
- Batteries lose their capacity over time or stop charging at all
- We sometimes drop them, and replacement parts can often be expensive and difficult to find
- Sometimes I spill things on the keyboard, or some keys just wear out over time with normal use
- Power jacks wear out and proper charging becomes unreliable or impossible
Some parts on your vehicle are difficult to repair/replace, not because they necessarily have to be, but because manufacturers would prefer that you have the vehicle repaired at a dealership.
Unfortunately, many computer vendors work the same way!
Laptops are often **designed** to be difficult to fix so that you will simply purchase a new laptop.
![Laptop Graveyard](../images/misc/laptop-graveyard.jpg)
**This must stop.**
# Why does open-source matter so much?
Proprietary, closed-source products:
@ -12,8 +28,8 @@ On the other hand, open-source projects provide:
## Transparency
Most complex hardware projects are closed-source (i.e. black box) and you may only indirectly infer how components are connected or how things operate in general.
Open-source products transparency and freedom to know as much as possible about the products you and others enjoy.
Most complex hardware projects are closed-source (i.e. a black box) and you may only indirectly infer how components are connected or how things generally operate.
Open-source products provide transparency and the freedom to know as much as possible about the products you and others enjoy.
You are able to review and modify open-source software.
You have full access to both the hardware and the software components and you are able to control every bit of your laptop.
You don't even have to purchase anything to access these resources; you can use our work (or parts of it) as a basis for existing projects.
@ -26,14 +42,14 @@ For example, you are able to add more processors, memories, etc.
It also gives you independence and self-sufficiency.
If a problem arises (any problem!), you have the freedom to fix it.
We provide the hardware design files and schematics for the TERES-I laptop.
This repository provides the hardware design files and schematics for the TERES-I laptop.
The hardware design is made with an open-source CAD tool called KiCad.
## Peace Of Mind
There is nothing hidden or "fine print" for you to worry about.
No lawyers will chase after you for using this material for personal or commercial use.
(Check the license for further information.)
There is no scary, hidden text or legal "fine print" for you to worry about.
No lawyers will chase after you for using this material, either for personal or commercial use.
Consult the [license](../../LICENSE) for further information.
## Ease Of Use
@ -43,18 +59,33 @@ Documentation can behave as living documents - aggregated reference materials to
## Education
There is great educational value of open-source products inherent in the availability of materials to study.
You will likely learn many new things during assembly of this DIY laptop.
You will likely learn many new things during assembly of this laptop.
You can build it together along with children or students, sparking interest in electronics and technology in general.
You will know every bit of your laptop and will be able to fix if something doesn't suit your needs or gets damaged.
You will have the freedom to learn about every aspect of this computer system and will have the resources available to fix it if something doesn't suit your needs or gets damaged.
## Support
You don't have to count only on the availability of the technical support.
Don't like the way something works, have an idea for an improvement, or think the documentation sucks?
You can improve it yourself or ask others to help!
You don't have to solely rely on availability of technical support.
If you don't like the way something works, have an idea for an improvement, or think the documentation sucks, you have the freedom to improve it yourself or ask others for help!
## Longevity
Open source gives guarantee for longevity.
Open source guarantees longevity.
Contributors may fork the project, make improvements, and merge those improvements back into the main project to benefit everyone.
There is no concern that a company goes bankrupt and the products disappear.
If a particular component (i.e. an integrated circuit or capacitor, etc) becomes obsolete or unavailable, the general public has the freedom to replace it within the design files with a more modern or common component.
# Sanity check
How open it will be?
Everyone has his own definition for openness.
- One may want open source GPU drivers
- One may need electrolyte capacitors fluid formula
- One may want to know how transistors are photo-imaged onto the silicon wafer
We can't please everyone!
The more things are open the better, but if a particular component, transistor, resistor, or capacitor may be purchased in relatively low quantities, it will work.
If you can learn, study, and reproduce the design using commonly-sourced components, it is considered "open source" to us.
If the schematics, CAD files, Linux build scripts, etc, are available, this will be sufficient for someone to construct their own laptop.

@ -2,26 +2,25 @@
The TERES-I laptop is a completely open source hardware and software product.
You don't even need a purchase to access the design files.
The CAD files and full source code are available at GitHub and anyone can download, modify and use them for their own needs.
It is important to notice that the CAD design tool that we used to make the hardware of TERES-I is also completely free and open source KiCad.
The CAD files and full source code are available at [GitHub](https://github.com/OLIMEX/DIY-LAPTOP) and anyone can download, modify and use them for their own needs.
KiCad (the CAD design tool that we used to design the TERES-I hardware) is also completely free and open source.
The openness of the product puts incredible power and flexibility in the hands of the user.
If you want to implement new features, you are free to do so.
If you need another processor, more power, more memory, a better LCD, you have everything required to tailor this laptop according to your needs.
If you do not like the Linux distribution you have access to the sources and can generate any Linux distribution for your taste.
The Android SDK by Allwinner for the A64 chip can be used as another option for operating system.
If you do not like the Linux distribution, you have access to the sources and can generate any Linux distribution for your taste.
For systems with the Allwinner A64 processor, the Android SDK can be used as an operating system alternative.
The laptop is fully modular which means that there are number of possible ways to expand it.
We already have several ideas in mind.
One of them is to expand the laptop capabilities with an FPGA module so it can act as a digital storage oscilloscope, and a logic analyzer, turning it into a powerful portable laboratory instrument.
These FPGA expansion modules are currently work-in-progress and you can follow the development on web site at [www.olimex.com](https://www.olimex.com).
The laptop is fully modular, meaning that there are numerous possible ways to expand it.
For example, the capabilities of the laptop may be enhanced by implementing a Field-Programmable Gate Array (FPGA) so it can function as a digital storage oscilloscope and logic analyzer, thus turning it into a powerful portable laboratory instrument.
Development of these FPGA expansion modules are currently in progress; you can follow their development on the [OLIMEX web site](https://www.olimex.com).
TERES-I is environmentally friendly.
All components of the TERES-I are available for individual purchase, so you can replace just the broken part if one were to fail.
This lowers the maintenance costs and helps reducing the electronics waste.
The main board may also be upgraded without major revisions to the design, vastly reducing waste and time when new faster and better processors become available.
This lowers maintenance costs and helps reduce electronic waste.
The main board may also be upgraded without requiring major changes to the rest of the computing system, vastly reducing cost, waste and time when improved processors become available.
There are educational benefits in getting TERES-I you can assemble it with your children and teach them about electronics or how computers work.
Children may learn about basic computing components, how things are assembled together, and are able to learn to conduct repairs in case something goes wrong.
This may spark their interest in electronics and programming.
Assembling the laptop is relatively easy and even small child should be able to do it under adult supervision.
There are educational benefits in constructing and using the TERES-I.
You can assemble it with your children and teach them about electronics or how computers work.
Children may learn about fundamental computing components, how parts and circuit boards are assembled together, and are able to learn to conduct repairs in case something eventually goes wrong.
This may also spark their interest in electronics and programming!