diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 714524c..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2023 epiccurious/jade-diy developers - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md index 757f15b..52ba35a 100644 --- a/README.md +++ b/README.md @@ -1,215 +1,22 @@ -# Jade Do-It-Yourself Hardware Guide +# Yadigar DIY Hardware Wallet Guide -This guide is designed for the general user who is not incompetant with computers and is looking to secure **less** than $100,000 (in 2023 prices) worth of bitcoin. +Yadigar is an improved version of Blockstream's Jade firmware, featuring Turkish language support instead of English and optimized specifically for TTGO T-Display hardware. -## Table of Contents +Turn your TTGO T-Display into a bitcoin hardware wallet using the Yadigar firmware. -- [Background](#background) - - [What is a Jade?](#what-is-a-jade) - - [Motivation (Who Should Follow This Guide?)](#motivation-who-should-follow-this-guide) - - [Who Should NOT Follow This Guide?](#who-should-not-follow-this-guide) - - [MUST READ: Keep Your DIY Jade Secured](#must-read-keep-your-diy-jade-secured) - - [Current Limitations of Third-Party DIY Hardware](#current-limitations-of-third-party-diy-hardware) -- [Hardware Options](#hardware-options) - - [TTGO T-Display](#ttgo-t-display) - - [M5Stack M5StickC PLUS](#m5stack-m5stickc-plus) - - [M5Stack Core Basic](#m5stack-core-basic) - - [M5Stack FIRE v2.6](#m5stack-fire-v26) -- [Set-Up Instructions](#set-up-instructions) - - [Use the Semi-Automated Script](#use-the-semi-automated-script) - - [Use a Device-Specific Script](#use-a-device-specific-script) - - [Run the Commands Manually](#run-the-commands-manually) -- [Acknowledgements](#acknowledgements) +## Hardware Required +- TTGO T-Display +- USB cable +- Computer running Linux, macOS, or ChromeOS -## Background - -### What is a Jade? - -[The Blockstream Jade](https://blockstream.com/jade) is a bitcoin-only hardware wallet that runs 100% on Open Source code. - -The firmware that runs Jade can also run other general purpose hardware that shares the same ESP32 microcontroller. - -### Motivation (Who Should Follow This Guide) - -Why Should I Follow This Guide? - -Three words: **supply chain attacks**. - -You understand that the person who sells you hardware for your bitcoin shouldn't know you use it for bitcoin. - -**WARNING:** Do not hold **more** than $100,000 (in 2023 prices) on **any** hardware wallet including the Jade. For large amounts, refer to the "Who Should NOT Follow This Guide?" section. - -### Who Should NOT Follow This Guide? - -1. You want to secure more than $100,000 (in 2023 dollars) worth of bitcoin. For large amounts, install Linux yourself on dedicated laptops and use multisig on Bitcoin Core following [a best-practices self-custody guide](https://yeticold.com). - - -2. You want to learn how to use the Jade hardware wallet. Refer to [the Jade's help center documentation](https://help.blockstream.com/hc/en-us/categories/900000061906-Blockstream-Jade/) or [contact Blockstream](https://help.blockstream.com/hc/en-us/requests/new) for software support. - - -3. You can't be bothered to operate a computer through the command line. We will be using the Terminal console, which some people find scary. It's not hard, I promise. - -4. You aren't willing to use [Linux](https://ubuntu.com/tutorials/install-ubuntu-desktop), macOS (running modern Arm-based hardware), or ChromOS. (This guide only supports Debian-based Linux, macOS, and ChromeOS for now but will eventually add support for other Linux distributions.) - -### MUST READ: Keep Your DIY Jade Secured - -tl;dr: ***You need to control physical access to your DIY Jade.*** - -Evil maid attacks, such as [this one done by hackers for a competitor](https://www.ledger.com/blog/firmware-extraction-evil-maid-attacks-on-blockstream-jade-hardware-wallet), will become easier and cheaper to perform over time. - -It's not just a risk of someone hacking or altering YOUR device. An evil maid can also swap your device with a new malicious device. - -**You need to control physical access to your DIY Jade** hardware wallet at all times as a countermeasure. Keep your DIY Jade locked up in a safe, lockbox, or some other method of restricting access. Don't let your house cleaner see your DIY Jade. - -For further reading, please see [[#1]](https://usa.kaspersky.com/blog/fake-trezor-hardware-crypto-wallet/28299/), [[#2]](https://media.ccc.de/v/35c3-9563-wallet_fail), [[#3]](https://blog.trezor.io/psa-non-genuine-trezor-devices-979b64e359a7), [[#4]](https://web.archive.org/web/20220820031918/https://www.reddit.com/r/ledgerwallet/comments/o154gz/comment/h1zagmk/). - -### Current Limitations of Third-Party DIY Hardware - -- No camera support. To build a DIY Jade with camera support, [please refer here](https://www.youtube.com/watch?v=V2yVKag2wlc). -- Need a documented process for updating firmware. - -[[back to top]](#table-of-contents) - -## Hardware Options - -You are better off buying the hardware directly from the hardware vendor than through a third-party channel like Amazon or Alibaba. In many cases, it's cheaper to buy direct too. - -### TTGO T-Display - -![TTGO T-Display](img/TTGO-T-Display.jpg) - -- **MSRP: [$8-$11](https://www.lilygo.cc/products/lilygo%C2%AE-ttgo-t-display-1-14-inch-lcd-esp32-control-board?variant=42720264683701), either the K164 or Q125 variant** -- Does not include a battery. Either keep it plugged in or add a generic battery for a few dollars. -- DO NOT confuse this hardware with the more expensive T-Display S3 or T-Display AMOLED products. - - -## Set-Up Instructions - -There are three options for flashing your device: -- [**Install with the Semi-Automated Script**](#install-with-the-semi-automated-script) (easiest way) -- [**Install with a Device-Specific Script**](#install-with-a-device-specific-script) (another easy way) -- [**Install by Running the Code Manually**](#install-by-running-the-code-manually) (harder way) - -### Use the Semi-Automated Script - -This option is recommended for the average user who doesn't know how to read and write bash. - -1. Read [this section about physically securing your DIY Jade](#must-read-keep-your-diy-jade-secured). - -2. Open the Terminal. - - On Linux, press `Ctrl+Alt+T`. - - On macOS, press `Command+Space`, type terminal, and press `return`. - - on ChromeOS, install Linux under Settings -> Advanced -> Developers. Then press `🔍 (search)` on the keyboard, type terminal and press `enter`. - -3. Run the following command (via copy-paste) in Terminal. - ```bash - /bin/bash -c "$(curl -sSL https://github.com/epiccurious/jade-diy/raw/master/flash_your_device)" - ``` - -4. When the script asks, choose your device (#1-#4). - -After the script completes, you should see the Jade initialization screen on your device. - -### Use a Device-Specific Script - -1. Read [this section about physically securing your DIY Jade](#must-read-keep-your-diy-jade-secured). - -2. Open the Terminal. - - On Linux, press `Ctrl+Alt+T`. - - On macOS, press `Command+Space`, type terminal, and press `return`. - - on ChromeOS, install Linux under Settings -> Advanced -> Developers. Then press `🔍 (search)` on the keyboard, type terminal and press `enter`. - -3. Run one of the following commands (via copy-paste) in Terminal. - - For the TTGO T-Dispay: - ``` - /bin/bash -c "$(curl -sSL https://github.com/sukunetsiz/yadigar-diy/raw/master/device_specific/flash_the_ttgo_tdisplay)" - ``` - -After the script completes, you should see the Jade initialization screen on your device. - -### Run the Commands Manually - -This options is provided for people who want to run the commands themselves. - -1. Read [this section about physically securing your DIY Jade](#must-read-keep-your-diy-jade-secured). - -2. Open the Terminal. On Linux, press `Ctrl+Alt+T`. On macOS, press `Command+Space`, type terminal, and press `return`. - -3. Install the required software packages. On a slow computer, this step can take over 20 minutes. Copy-and-paste the following lines into Terminal: - ```bash - sudo apt update - sudo apt install -y cmake git python3-pip python3-venv - [ -d ${HOME}/esp ] || mkdir ${HOME}/esp - git clone -b v5.1.1 --recursive https://github.com/espressif/esp-idf.git ${HOME}/esp/esp-idf - cd "${HOME}"/esp/esp-idf - ./install.sh esp32 - . ./export.sh - ``` -TODO: Add instructions for installing macOS dependendies. - -4. Download the Jade source code. Copy-and-paste the following lines into Terminal: - ```bash - git clone --recursive https://github.com/blockstream/jade "${HOME}"/jade - cd "${HOME}"/jade/ - git checkout $(git tag | grep -v miner | sort -V | tail -1) - ``` - -5. Load the pre-built configuration file for your DIY hardware. - - For the TTGO T-Display, run: - ```bash - cp configs/sdkconfig_display_ttgo_tdisplay.defaults sdkconfig.defaults - ``` - - For the M5Stack M5StickC Plus, run: - ```bash - cp configs/sdkconfig_display_m5stickcplus.defaults sdkconfig.defaults - ``` - - For the M5Stack Core, run: - ```bash - cp configs/sdkconfig_display_m5blackgray.defaults sdkconfig.defaults - ``` - - For the M5Stack Fire, run: - ```bash - cp configs/sdkconfig_display_m5fire.defaults sdkconfig.defaults - ``` - -6. Modify the configuration file you just loaded to disable logging in debug mode (a.k.a. "research and development" mode). - ```bash - sed -i.bak '/CONFIG_DEBUG_MODE/d' ./sdkconfig.defaults - sed -i.bak '1s/^/CONFIG_LOG_DEFUALT_LEVEL_NONE=y\n/' sdkconfig.defaults - rm sdkconfig.defaults.bak - ``` - -7. Build the firmware. - ``` - idf.py build - ``` - -8. Connect your device to your computer via USB. - -9. Enable read-write permissions for your device. - ```bash - [ -f /dev/ttyACM0 ] && sudo chmod o+rw /dev/ttyACM0 - [ -f /dev/ttyUSB0 ] && sudo chmod o+rw /dev/ttyUSB0 - ``` -TODO: Add macOS instructions. - -10. Flash (install) Jade onto your device. On a slow computer, this step can take over 10 minutes. Run the following command in Terminal: - ```bash - idf.py -b 115200 flash - ``` - -11. Either disable read-write permissions for your device or disconnect it. (Default permissions will be restored when you re-connect it.) - ```bash - [ -f /dev/ttyACM0 ] && sudo chmod o-rw /dev/ttyACM0 - [ -f /dev/ttyUSB0 ] && sudo chmod o-rw /dev/ttyUSB0 - ``` - -After the build and flash process completes, you should see the Jade initialization screen on your device. - -[[back to top]](#table-of-contents) +## Installation +1. Open Terminal +2. Copy and paste this command: +```bash +/bin/bash -c "$(curl -sSL https://github.com/sukunetsiz/yadigar-diy/raw/master/device_specific/flash_the_ttgo_tdisplay)" +``` ## Acknowledgements -Inspiration for this project came from: -- [Blockstream Jade](https://github.com/Blockstream/Jade/graphs/contributors) -- @YTCryptoGuide ([YouTube](https://youtube.com/CryptoGuide)). +- Thanks to [Blockstream](https://github.com/Blockstream/Jade) for the original Jade firmware that Yadigar is based on +- Thanks to GitHub user [epiccurious](https://github.com/epiccurious/jade-diy) whose DIY guide and repository served as the foundation for this project diff --git a/device_specific/flash_the_ttgo_tdisplay b/device_specific/flash_the_ttgo_tdisplay index 0adfbb4..13b5f67 100755 --- a/device_specific/flash_the_ttgo_tdisplay +++ b/device_specific/flash_the_ttgo_tdisplay @@ -11,12 +11,12 @@ cleanup() { fi } -working_directory="${HOME}/Downloads/diy_jade" +working_directory="${HOME}/Downloads/diy_yadigar" temp_directory="${working_directory}/temp" trap cleanup EXIT -jade_git_tag="0.4" -jade_save_directory="${working_directory}/jade" +jade_git_tag=$(curl -s https://api.github.com/repos/sukunetsiz/yadigar/releases/latest | grep -Po '"tag_name": "\K.*?(?=")') +jade_save_directory="${working_directory}/yadigar" jade_repo_url="https://github.com/sukunetsiz/yadigar.git" esp_idf_git_tag="v5.3.1" @@ -31,8 +31,8 @@ clear echo "------------------------------------------------------------" echo "------------------------------------------------------------" echo "--- ---" -echo "--- Do-It-Yourself Jade Install Script ---" -echo "--- Written by Epic Curious ---" +echo "--- Do-It-Yourself Yadigar Install Script ---" +echo "--- Written by sukunetsiz ---" echo "--- ---" echo "------------------------------------------------------------" echo "------------------------------------------------------------" @@ -97,4 +97,4 @@ fi idf.py flash -echo -e "\nSUCCESS! Jade ${jade_version} is now installed on your ${chosen_device}.\nYou can close this window.\n" +echo -e "\nSUCCESS! Yadigar ${jade_version} is now installed on your ${chosen_device}.\nYou can close this window.\n" diff --git a/img/M5Stack-Core-Basic.jpg b/img/M5Stack-Core-Basic.jpg deleted file mode 100644 index a9d664f..0000000 Binary files a/img/M5Stack-Core-Basic.jpg and /dev/null differ diff --git a/img/M5Stack-FIRE.jpg b/img/M5Stack-FIRE.jpg deleted file mode 100644 index 564b095..0000000 Binary files a/img/M5Stack-FIRE.jpg and /dev/null differ diff --git a/img/M5Stack-M5StickC-PLUS.jpg b/img/M5Stack-M5StickC-PLUS.jpg deleted file mode 100644 index 835bc41..0000000 Binary files a/img/M5Stack-M5StickC-PLUS.jpg and /dev/null differ