From 5bd518877ab5118165f19e3856975dbabb1d71b0 Mon Sep 17 00:00:00 2001 From: JC Staudt Date: Wed, 30 May 2018 21:10:17 -0700 Subject: [PATCH] Expand main product overview; add initial FAQ --- README.md | 23 +++++++++++++---------- doc/web/README.md | 1 + doc/web/intro_what-is-teres-i.md | 8 -------- doc/web/res_faq.md | 25 +++++++++++++++++++++++++ 4 files changed, 39 insertions(+), 18 deletions(-) create mode 100644 doc/web/README.md delete mode 100644 doc/web/intro_what-is-teres-i.md create mode 100644 doc/web/res_faq.md diff --git a/README.md b/README.md index 14db7d49..8dd08b77 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,15 @@ ## Overview -TERES-I is a Do-It-Yourself (DIY) Free/Open Source Hardware ([FOSH](https://wikipedia.org/wiki/Open-source_hardware)) and Software ([FOSS](https://wikipedia.org/wiki/Free_and_open-source_software)) laptop design leveraging ARM64 and x86 processors. +TERES-I is a Do-It-Yourself (DIY) Free/Open Source Hardware ([FOSH](https://wikipedia.org/wiki/Open-source_hardware)) and Software ([FOSS](https://wikipedia.org/wiki/Free_and_open-source_software)) laptop design. +It runs Linux on 64-bit ARM64 and x86 processors. + DIY kits are ready-to-assemble using the [instructions provided](doc/web/hw_assembly.md) and may be purchased [here](https://www.olimex.com/Products/DIY-Laptop/KITS). -* [What is TERES-I?](doc/web/intro_what-is-teres-i.md) -* [Where does the name TERES come from?](doc/web/intro_name-origin.md) -* [What makes this laptop so different?](doc/web/intro_what-is-unique.md) -* [Why does open-source matter so much?](doc/web/intro_importance-of-open-source.md) -* [Where are the open-source materials?](doc/web/intro_sources.md) +TERES-I has a stylish and elegant shape and an 11.6” LCD screen. +It is also a very light product. +Weighing less than one kilogram, it is convenient to carry when traveling. +TERES-I is great for playing videos, browsing the web, or using a plethora of development suites. ## Assembling your TERES-I @@ -25,15 +26,17 @@ DIY kits are ready-to-assemble using the [instructions provided](doc/web/hw_asse ## Hardware -* [TERES-A64-WHITE](https://www.olimex.com/Products/DIY-Laptop/KITS/TERES-A64-WHITE/open-source-hardware) -* [TERES-A64-BLACK](https://www.olimex.com/Products/DIY-Laptop/KITS/TERES-A64-BLACK/open-source-hardware) -* [Spare parts](https://www.olimex.com/Products/DIY-Laptop/SPARE-PARTS/) +* [TERES-A64-WHITE](https://www.olimex.com/Products/DIY-Laptop/KITS/TERES-A64-WHITE) +* [TERES-A64-BLACK](https://www.olimex.com/Products/DIY-Laptop/KITS/TERES-A64-BLACK) +* [Spare parts](https://www.olimex.com/Products/DIY-Laptop/SPARE-PARTS) ## Software TERES-I was designed to run on Linux distributions, but may also run Android and Windows operating systems. +The laptop's mainboard has eMMC flash loaded with Ubuntu Mate and basic programs – Internet browser, Open Office, Arduino IDE, IceStorm FPGA Verilog tools, a video player, etc. +Additional software is also available from Ubuntu repositories. -* [Installing a fresh official image to TERES-I](doc/web/sw_fresh-os.md) +* [Installing an image](doc/web/sw_fresh-os.md) * [Updating an image](doc/web/sw_updating-os.md) * [Building an image](SOFTWARE/A64-TERES/scripts/README.md) diff --git a/doc/web/README.md b/doc/web/README.md new file mode 100644 index 00000000..d3216d9e --- /dev/null +++ b/doc/web/README.md @@ -0,0 +1 @@ +This directory contains various documentation pages that are linked from a main README. diff --git a/doc/web/intro_what-is-teres-i.md b/doc/web/intro_what-is-teres-i.md deleted file mode 100644 index a984d999..00000000 --- a/doc/web/intro_what-is-teres-i.md +++ /dev/null @@ -1,8 +0,0 @@ -# What is TERES-I? - -TERES-I is an open source hardware and open source software do-it-yourself laptop running Linux on a quad core 64-bit ARM processor. -It is very light product – weighing less than one kilogram, convenient to carry when traveling. -TERES-I has a stylish and elegant shape and an 11.6” LCD screen. -You can play videos, browse the Internet, and write programs. -The laptop's mainboard has eMMC flash loaded with Ubuntu Mate and basic programs – Internet browser, Open Office, Arduino IDE, IceStorm FPGA Verilog tools, a video player, etc. -You can, of course, install additional software from the Ubuntu repositories. diff --git a/doc/web/res_faq.md b/doc/web/res_faq.md new file mode 100644 index 00000000..f209fc19 --- /dev/null +++ b/doc/web/res_faq.md @@ -0,0 +1,25 @@ +# Frequently Asked Questions (FAQ) + +## General + +* [Where does the name TERES come from?](intro_name-origin.md) +* [What makes this laptop so different?](intro_what-is-unique.md) +* [Why does open-source matter so much?](intro_importance-of-open-source.md) +* [Where are the open-source materials?](intro_sources.md) +* [How may I contribute to this project?](../../CONTRIBUTING.md) +* I have a question or feedback that does not constitute opening up a ticket. Where do I go? + * Check out the [user forum](https://www.olimex.com/forum/index.php?board=39.0)! + +## Hardware + +* Where are the design files for a 3D-printed laptop enclosure? + * None are currently available from the immediate developers, as they are less savvy with 3D-modeling. The boards were initially designed to fit an affordable plastic laptop enclosure for the time being. +* Are there alternative keyboard options available? + * None are currently available. Please test compatibility, design a 3-D printed keyboard bezel, and it may get implemented! + +## Software + +* Does the TERES-I have an upstream mainline kernel? + * The sunxi comunity is working on A64 mainline support. The results are documented [here](https://linux-sunxi.org/Linux_mainlining_effort), [here](https://linux-sunxi.org/A64), and [here](https://lkml.org/lkml/2018/4/30/288). +* How do I install operating system _____? + * Please reference the [software documentation](../../SOFTWARE/README.md) section for details. If your desired operating system is not listed, it is most likely not yet supported. We'd love your help getting it to run on the TERES-I!