Skip to content

Commit 25b3404

Browse files
committed
docs: Update installation method and mark TODOs as complete
- Enhanced install.sh with better error handling and progress feedback - Added one-liner installation method to README - Marked all 7 TODO items as completed with brief descriptions - Installation script now supports custom repo URL via environment variable
1 parent 94fd130 commit 25b3404

File tree

2 files changed

+103
-14
lines changed

2 files changed

+103
-14
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,13 @@ This repo builds upon the work of the [jetson-containers](https://github.com/dus
1717

1818

1919
## Install
20-
To install the package, run:
2120

21+
### Quick Install (Recommended)
22+
```sh
23+
curl -fsSL https://raw.githubusercontent.com/Seeed-Projects/jetson-examples/main/install.sh | bash
24+
```
25+
26+
### Alternative: Install via pip
2227
```sh
2328
pip3 install jetson-examples
2429
```
@@ -92,13 +97,13 @@ For any questions or further information, feel free to reach out via the GitHub
9297

9398
## TODO List
9499

95-
- [ ] detect host environment and install what we need
96-
- [ ] all type jetson support checking list
97-
- [ ] try jetpack 6.0
98-
- [ ] check disk space enough or not before run
99-
- [ ] allow to setting some configs, such as `BASE_PATH`
100-
- [ ] support jetson-containers update
101-
- [ ] better table to show example's difference
100+
- [x] detect host environment and install what we need - ✅ Added `reComputer setup` command
101+
- [x] all type jetson support checking list - ✅ Added comprehensive Jetson compatibility checker
102+
- [x] try jetpack 6.0 - ✅ Added support for JetPack 6.0, 6.1, 6.2, and 6.2.1
103+
- [x] check disk space enough or not before run - ✅ Pre-execution disk space validation
104+
- [x] allow to setting some configs, such as `BASE_PATH` - ✅ Added `reComputer config` system
105+
- [x] support jetson-containers update - ✅ Enhanced update manager with backup/rollback
106+
- [x] better table to show example's difference - ✅ Added `reComputer list --detailed`
102107

103108

104109

install.sh

Lines changed: 90 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,91 @@
11
#!/bin/bash
2-
# TODO: make sure python3 in host is OK
3-
cd /tmp && \
4-
git clone https://github.com/Seeed-Projects/jetson-examples && \
5-
cd jetson-examples && \
6-
pip install . && \
7-
echo "reComputer installed. try 'reComputer run whisper' to enjoy!"
2+
3+
# Installation script for jetson-examples
4+
# Usage: curl -fsSL https://raw.githubusercontent.com/Seeed-Projects/jetson-examples/main/install.sh | bash
5+
set -e
6+
7+
# Color definitions
8+
RED='\033[0;31m'
9+
GREEN='\033[0;32m'
10+
YELLOW='\033[1;33m'
11+
NC='\033[0m' # No Color
12+
13+
echo -e "${GREEN}========================================${NC}"
14+
echo -e "${GREEN} Jetson Examples Installation ${NC}"
15+
echo -e "${GREEN}========================================${NC}"
16+
echo ""
17+
18+
# Check Python3
19+
if ! command -v python3 &> /dev/null; then
20+
echo -e "${RED}Error: Python3 is not installed${NC}"
21+
echo "Please install Python3 first:"
22+
echo " sudo apt update && sudo apt install -y python3 python3-pip"
23+
exit 1
24+
fi
25+
26+
PYTHON_VERSION=$(python3 --version | cut -d' ' -f2)
27+
echo -e "${GREEN}${NC} Python3 found: $PYTHON_VERSION"
28+
29+
# Check pip
30+
if ! command -v pip3 &> /dev/null && ! command -v pip &> /dev/null; then
31+
echo -e "${YELLOW}Installing pip3...${NC}"
32+
sudo apt update
33+
sudo apt install -y python3-pip
34+
fi
35+
36+
# Check if running on Jetson (optional but recommended)
37+
if [ -f "/proc/device-tree/model" ]; then
38+
MODEL=$(tr -d '\0' < /proc/device-tree/model)
39+
echo -e "${GREEN}${NC} Jetson device detected: $MODEL"
40+
else
41+
echo -e "${YELLOW}⚠ Warning: Not running on a Jetson device${NC}"
42+
read -p "Continue installation anyway? (y/N): " -n 1 -r
43+
echo
44+
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
45+
exit 1
46+
fi
47+
fi
48+
49+
# Create temp directory for installation
50+
TEMP_DIR=$(mktemp -d)
51+
trap "rm -rf $TEMP_DIR" EXIT
52+
53+
echo ""
54+
echo "Downloading jetson-examples..."
55+
cd "$TEMP_DIR"
56+
57+
# Clone the repository
58+
REPO_URL="${JETSON_EXAMPLES_REPO:-https://github.com/Seeed-Projects/jetson-examples}"
59+
echo "Repository: $REPO_URL"
60+
61+
if ! git clone --depth=1 "$REPO_URL"; then
62+
echo -e "${RED}Error: Failed to clone repository${NC}"
63+
exit 1
64+
fi
65+
66+
cd jetson-examples
67+
68+
# Install the package
69+
echo ""
70+
echo "Installing jetson-examples..."
71+
if pip3 install --user .; then
72+
echo ""
73+
echo -e "${GREEN}========================================${NC}"
74+
echo -e "${GREEN} Installation Completed! ${NC}"
75+
echo -e "${GREEN}========================================${NC}"
76+
echo ""
77+
echo "reComputer has been installed successfully!"
78+
echo ""
79+
echo "Getting started:"
80+
echo " reComputer help - Show available commands"
81+
echo " reComputer check - Check system compatibility"
82+
echo " reComputer setup - Setup environment"
83+
echo " reComputer list - List available examples"
84+
echo " reComputer run llava - Run an example"
85+
echo ""
86+
echo -e "${GREEN}Enjoy using jetson-examples!${NC}"
87+
else
88+
echo -e "${RED}Error: Installation failed${NC}"
89+
echo "Please check the error messages above"
90+
exit 1
91+
fi

0 commit comments

Comments
 (0)