diff --git a/README.md b/README.md index bb11fca..331b48a 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,101 @@ -# The Terminal Homepage - -## Installation steps: -1. download the zip file -2. Extract the zip file -3. move the "Startup Page" folder somewhere safe (where you wont delete it by mistake) :) -4. open the `homepage.bat` file with notepad. (right click and select "edit in notepad") -5. paste the Folder path in the first line. (the folder you just placed in step 3) -6. Search and open "Task Scheduler" -7. Select "Create basic Task" on the right -8. give it a name, set trigger event to "when the computer starts" -9. in the Start a Program Tab browse and select the homepage.bat file. -10. Click on the checkbox and hit finish -11. In properties check the "Hidden" Checkbox. -12. Also check the "Run with highest privileges" and "Run wether user is logged on or not" (OPTIONAL) - -13. Open your browser settings and find "On Startup" Tab (might vary on different browsers) -14. Select "Open a Specific page" -15. Paste the following URL `http://localhost:8000/index.html` -16. RESTART YOUR LAPTOP +# πŸ”₯ TerminalTab - Make Your New Tab Awesome! πŸš€ + +![TerminalTab](https://github.com/user-attachments/assets/5d5ffed3-47d4-4f4f-84d4-8c049a5d52b6) + +## Description + +Are you tired of staring at Google's boring, plain new tab page? 😴 Do you wish your new tab could be as cool and productive as you are? Well, you're in luck! Welcome to **TerminalTab** - the only new tab page that understands your inner awesomeness. 😎 + +Why settle for Google's vanilla new tab when you can have a homepage that: +- **Looks fantastic** (like a homepage should). +- **Has all the features you need** (unlike Google's "here's a search bar, you're welcome"). +- **Makes you feel like a tech wizard** (move over, Tony Stark). + +Say goodbye to boring old google tab and hello to a new tab experience that’s fun, functional, and fabulously you! + +## Features + +- 🎨 **Customizable Themes**: Because one size does not fit all. +- πŸ’» **Terminal-like Design**: To remind you of those nostalgic coding sessions you definitely dont hate. +- πŸ”Ž **Quick Search Options**: Choose your preferred search engine and go! +- 🌟 **Favorite Links**: Access your go-to websites in a jiffy. +- 😍 **Fidgety Backgrounds**: A Background designed to pass time... especially if you're bored :) + +## Instructions (One Time Setup) + +### Windows + +1. **Download the ZIP file**: + - Click that download button like your life depends on it! πŸ’ͺ + +2. **Extract the ZIP file**: + - Unzip it like you unzip everything else! πŸ΄β€β˜ οΈ + +3. **Move the "Startup Page" folder**: + - Place it somewhere safe (where you won’t accidentally delete it) - maybe not next to your gf's pics. πŸ˜‰ + +4. **Edit `homepage.bat`**: + - Right-click on `homepage.bat` and select "Edit in Notepad". + - You'll see a blank space at the top. Paste the folder path from Step 3. + ![Screenshot 2024-08-04 224035](https://github.com/user-attachments/assets/b9cd1c5e-36bf-42c5-8d97-4cd24628b659) + +5. **Open Task Scheduler**: + - Hit the Start button and search for "Task Scheduler". This is where the magic happens. πŸ§™β€β™‚οΈ + ![Screenshot 2024-08-05 161956](https://github.com/user-attachments/assets/2f8fb824-762d-4bde-8eaa-f0875b17dec7) + +6. **Create a Basic Task**: + - Click "Create Basic Task" on the right. Give it a name that makes you smile. + ![Screenshot 2024-08-05 162038](https://github.com/user-attachments/assets/13307e05-dadd-4c56-8811-214744347bc4) + +7. **Set the Trigger Event**: + - Choose "When the computer starts". Because why wait, right? πŸŒ… + ![Screenshot 2024-08-05 162048](https://github.com/user-attachments/assets/f3aad8f5-332b-4fec-b2e8-605c1c182aab) + +8. **Start a Program**: + - In the "Start a Program" tab, browse and select the `homepage.bat` file. + ![Screenshot 2024-08-05 162112](https://github.com/user-attachments/assets/3f649b60-b9da-449e-bcb4-86e810c00d6f) + +9. **Finish Setup**: + - Click on the checkbox and hit "Finish". You’re almost there! 🏁 + ![Screenshot 2024-08-05 162127](https://github.com/user-attachments/assets/cf8dbd9f-61a5-46e5-9099-3c98652bdfe8) + +10. **Hide the Task**: + - In properties, check the "Hidden" checkbox. It's good to keep secrets. 🀫 + ![Screenshot 2024-08-05 162223](https://github.com/user-attachments/assets/59d15d51-a2a7-405d-82dc-5c2dc1b91e65) + +11. **Optional Settings**: + - Also check "Run with highest privileges" and "Run whether user is logged on or not". The faster the better right?. πŸš… + +12. **Deselect Conditions and Settings**: + - In the property menu, deselect a few things under the Conditions and Settings tab. (We’ll add screenshots for this to make it super clear. πŸ“Έ) + ![Screenshot 2024-08-05 163137](https://github.com/user-attachments/assets/7e7257c0-0f45-47a3-9f47-37f19c9a164e) + ![Screenshot 2024-08-05 163157](https://github.com/user-attachments/assets/3e65965a-e9a6-493c-b571-25ede68db49b) + +13. **Install the Extension**: + - Open your browser and install this web extension: [New Tab Redirect](https://chromewebstore.google.com/detail/new-tab-redirect/icpgjfneehieebagbmdbhnlpiopdcmna). + +14. **Set the New Tab URL**: + - Paste this URL in the extension’s menu. This is where the magic happens. 🌟 + ``` + http://localhost:8000/index.html + ``` + +15. **Restart Your Laptop**: + - Give your laptop a quick restart and voilΓ ! Your terminal-themed homepage awaits. πŸš€ + +And there you have it! Your new tab page is ready to dazzle and delight. If any step seems tricky, don’t worry - we’ll have screenshots to guide you through! πŸ“· + +Enjoy your new, super cool custom homepage! 🌐 + + +### Mac + +Coming soon πŸ˜‰ + +## Feedback and Issues + +Found a bug? Got a brilliant idea for a new feature? Head over to the [Issues](https://github.com/mcspidey95/TerminalTab/issues) tab and let us know! Your feedback is what makes this project better. πŸ’ͺ + +--- + +Let's make browsing better, one tab at a time! 🌟