|
1 | 1 |
|
2 | | -## What is Codekub? |
3 | | - |
4 | | -**Codekub** is a beginner-focused Linux setup script that installs and configures everything a **Computer Science / IT student** needs to start coding **from day one**. |
5 | 2 |
|
6 | | -Instead of spending weeks figuring out: |
| 3 | +## What is Codekub? |
7 | 4 |
|
8 | | -* which tools to install |
9 | | -* how to configure them |
10 | | -* why things break |
| 5 | +**Codekub** is a beginner-focused Linux setup script that installs and configures everything a **CSE/IT student** needs to start coding **from day one** — no guessing which tools to install or how to configure them. |
11 | 6 |
|
12 | | -Codekub gives you a **ready-to-learn development environment**, while also **teaching you what each tool does and why it exists**. |
| 7 | +It gives you a **ready-to-learn development environment** while also **explaining what each tool does**. |
13 | 8 |
|
14 | 9 | --- |
15 | 10 |
|
16 | 11 | ## How Codekub Works |
17 | 12 |
|
18 | | -Codekub is installed using a single command: |
| 13 | +Install with a single command: |
19 | 14 |
|
20 | 15 | ```bash |
21 | | -wget -qO- https://omakub.org/install | bash |
| 16 | +curl -sSL https://raw.githubusercontent.com/CodeCompasss/codekub/main/boot.sh | bash |
22 | 17 | ``` |
23 | 18 |
|
24 | | -> ⚠️ Note: |
25 | | -> The *idea* of using a single install script is inspired by **Omakub**, but **Codekub is a completely different project** with a different goal and audience. |
| 19 | +> ⚠️ Inspired by **Omakub**, but **Codekub is different** — it’s learning-first, not just installation. |
26 | 20 |
|
27 | 21 | --- |
28 | 22 |
|
29 | | -## Codekub vs Omakub (Very Important Difference) |
30 | | - |
31 | | -### Omakub |
32 | | - |
33 | | -* Made for **experienced developers** |
34 | | -* Opinionated, fast, production-ready |
35 | | -* Assumes you already understand Linux, terminals, and tools |
36 | | -* Focuses on *getting work done quickly* |
37 | | - |
38 | | -### Codekub |
| 23 | +## Codekub vs Omakub |
39 | 24 |
|
40 | | -* Made for **beginners and students** |
41 | | -* Learning-first, explanation-driven setup |
42 | | -* Beginner-friendly defaults |
43 | | -* Focuses on *understanding tools*, not hiding them |
| 25 | +| Feature | Omakub | Codekub | |
| 26 | +| -------- | ---------------------- | ------------------------- | |
| 27 | +| Audience | Experienced developers | Beginners & students | |
| 28 | +| Goal | Quick setup for work | Learning tools & concepts | |
| 29 | +| Approach | Opinionated, fast | Explanation-driven | |
44 | 30 |
|
45 | | -👉 **Omakub installs tools. |
46 | | -👉 Codekub teaches tools.** |
| 31 | +👉 **Omakub installs tools. Codekub teaches tools.** |
47 | 32 |
|
48 | 33 | --- |
49 | 34 |
|
50 | | -## Who Is Codekub For? |
51 | | - |
52 | | -🎓 **CSE / IT students** |
53 | | -🧑💻 **Programming beginners** |
54 | | -🚀 **Anyone learning development tools from scratch** |
55 | | - |
56 | | -If you are: |
| 35 | +## Who Should Use Codekub? |
57 | 36 |
|
58 | | -* new to Linux |
59 | | -* confused by terminals |
60 | | -* unsure why developers use tools like Git, Docker, or Neovim |
| 37 | +* New to Linux or terminals |
| 38 | +* Unsure why tools like Git, Docker, or Neovim exist |
| 39 | +* Want a learning-first setup |
61 | 40 |
|
62 | | -**Codekub is for you.** |
| 41 | +Perfect for **students, beginners, or anyone learning development tools**. |
63 | 42 |
|
64 | 43 | --- |
65 | 44 |
|
66 | 45 | ## What Codekub Installs |
67 | 46 |
|
68 | | -Codekub provides a **modern, real-world developer environment**, carefully chosen for learning. |
| 47 | +### Languages & Compilers |
69 | 48 |
|
70 | | -### Programming Languages & Compilers |
71 | | - |
72 | | -* C / C++ |
73 | | -* Java |
74 | | -* Python |
75 | | -* Rust |
76 | | -* Node.js |
| 49 | +* C / C++ / Java / Python / Rust / Node.js |
77 | 50 |
|
78 | 51 | ### Developer Tools |
79 | 52 |
|
80 | | -* Git |
81 | | -* Docker |
82 | | -* VS Code |
83 | | -* Neovim |
84 | | -* Tmux |
85 | | -* Modern CLI utilities |
| 53 | +* Git, Docker, VS Code, Neovim, Tmux, modern CLI utilities |
86 | 54 |
|
87 | 55 | ### Environment Setup |
88 | 56 |
|
89 | 57 | * Preconfigured dotfiles |
90 | 58 | * Clean GNOME customizations |
91 | | -* Learning-friendly terminal setup |
92 | | -* Sensible defaults (no unnecessary complexity) |
| 59 | +* Beginner-friendly terminal setup |
| 60 | +* Sensible defaults |
93 | 61 |
|
94 | | -Everything works **out of the box**, but nothing is hidden. |
| 62 | +Everything works **out of the box** — nothing is hidden. |
95 | 63 |
|
96 | 64 | --- |
97 | 65 |
|
98 | | -## What Makes Codekub Different |
99 | | - |
100 | | -Codekub emphasizes: |
101 | | - |
102 | | -✅ Clear explanations of tools and configurations |
103 | | -✅ Beginner-oriented defaults |
104 | | -✅ Step-by-step guides |
105 | | -✅ Practical learning over “magic scripts” |
106 | | -✅ Modern development workflows |
107 | | -✅ A clean, beautiful Linux experience without overwhelm |
| 66 | +## Key Benefits |
108 | 67 |
|
109 | | -Instead of *just installing tools*, **Codekub helps you understand them**. |
| 68 | +* Clear explanations of tools |
| 69 | +* Beginner-friendly defaults |
| 70 | +* Step-by-step guides |
| 71 | +* Practical learning over “magic scripts” |
| 72 | +* Modern development workflows |
| 73 | +* Clean Linux experience without overwhelm |
110 | 74 |
|
111 | 75 | --- |
112 | 76 |
|
113 | 77 | ## Learning-First Philosophy |
114 | 78 |
|
115 | | -Most setups assume: |
116 | | - |
117 | | -> “You’ll figure it out later.” |
118 | | -
|
119 | 79 | Codekub assumes: |
120 | 80 |
|
121 | 81 | > “You are learning — let’s explain everything.” |
122 | 82 |
|
123 | 83 | You learn: |
124 | 84 |
|
125 | | -* what each tool does |
126 | | -* why developers use it |
127 | | -* how it fits into real projects |
| 85 | +* What each tool does |
| 86 | +* Why developers use it |
| 87 | +* How it fits in real projects |
128 | 88 |
|
129 | | -This makes Codekub ideal for: |
130 | | - |
131 | | -* academic labs (personal learning) |
132 | | -* self-study |
133 | | -* first-time Linux users |
134 | | -* long-term skill building |
| 89 | +Ideal for **self-study, labs, or first-time Linux users**. |
135 | 90 |
|
136 | 91 | --- |
137 | 92 |
|
138 | | -## License & Usage Notice |
139 | | - |
140 | | -✅ **Free for students and personal learning** |
141 | | -❌ **Not allowed for commercial use** |
142 | | -❌ **Not allowed for college labs or institutional deployment** |
143 | | - |
144 | | -Codekub is built to help **individual learners**, not organizations. |
145 | | - |
146 | | ---- |
147 | | - |
148 | | -## Project Background (Transparency Note) |
149 | | - |
150 | | -This project started **before I knew about Omakub**. |
151 | | -Later, the **script-based installer idea** was inspired by Omakub. |
152 | | - |
153 | | -However: |
| 93 | +## License & Usage |
154 | 94 |
|
155 | | -* Codekub has a **different mission** |
156 | | -* Codekub targets **beginners** |
157 | | -* Codekub focuses on **learning, not speed** |
| 95 | +* ✅ Free for students and personal learning |
| 96 | +* ❌ Not for commercial use |
| 97 | +* ❌ Not for college or institutional deployment |
158 | 98 |
|
0 commit comments