Improve instructions

This commit is contained in:
Zach Latta 2025-05-28 18:38:08 -04:00
parent 983bcaa687
commit 6cf11c8caf
9 changed files with 200 additions and 127 deletions

View file

@ -46,19 +46,19 @@
<div>
<strong>Popular Ones:</strong>
<ul style="margin-top: 0.5rem;">
<li>VS Code</li>
<li>PyCharm</li>
<li>Vim</li>
<li>Sublime Text</li>
<li><%= link_to "VS Code", doc_path("editors/vs-code") %></li>
<li><%= link_to "PyCharm", doc_path("editors/pycharm") %></li>
<li><%= link_to "Vim", doc_path("editors/vim") %></li>
<li><%= link_to "Sublime Text", doc_path("editors/sublime-text") %></li>
</ul>
</div>
<div>
<strong>Lots More:</strong>
<ul style="margin-top: 0.5rem;">
<li>Atom, Brackets</li>
<li><%= link_to "Atom", doc_path("editors/atom") %>, <%= link_to "Brackets", doc_path("editors/brackets") %></li>
<li>All JetBrains apps</li>
<li>Command Line</li>
<li><a href="https://wakatime.com/plugins" target="_blank">40+ others</a></li>
<li><%= link_to "Command Line", doc_path("editors/terminal") %></li>
<li><a href="#supported-editors" onclick="document.getElementById('all-editors').parentElement.open = true; document.getElementById('all-editors').scrollIntoView({behavior: 'smooth'});">70+ others</a></li>
</ul>
</div>
</div>

View file

@ -1,29 +1,37 @@
# Android Studio Setup Guide
# How to Track Time in Android Studio
![Android Studio](/images/editor-icons/android-studio-128.png)
Follow these steps to start tracking your coding time in Android Studio with Hackatime.
Let's set up Android Studio to count how much time you spend making Android apps!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with Android Studio.
## Step 3: Install Android Studio Plugin
## Step 3: Add the Plugin to Android Studio
Follow the detailed plugin installation instructions on the [WakaTime Android Studio page](https://wakatime.com/android-studio).
1. Open Android Studio
2. Go to **File****Settings** (on Mac: **Android Studio****Preferences**)
3. Click **Plugins** on the left
4. Click the **Marketplace** tab at the top
5. Type "WakaTime" in the search box
6. Click **Install** next to WakaTime
7. Click **Restart IDE** when it asks
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
That's it! The plugin will use your settings from Step 2.
## Troubleshooting
## If Something Goes Wrong
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting Android Studio after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
## Next Steps
**Plugin not working?** Close Android Studio and open it again.
Once configured, your coding time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy coding!
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start building your Android app! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.

View file

@ -1,29 +1,35 @@
# Cursor Setup Guide
# How to Track Time in Cursor
![Cursor](/images/editor-icons/cursor-128.png)
Follow these steps to start tracking your coding time in Cursor with Hackatime.
Let's set up Cursor (the AI code editor) to count how much time you spend coding!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with Cursor.
## Step 3: Install Cursor Plugin
## Step 3: Add the Plugin to Cursor
Follow the detailed plugin installation instructions on the [WakaTime Cursor page](https://wakatime.com/cursor).
1. Open Cursor
2. Click the squares icon on the left (Extensions)
3. Type "WakaTime" in the search box
4. Click the **Install** button next to WakaTime
5. Cursor might ask you to restart - click **Reload** if it does
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
That's it! The plugin will use your settings from Step 2.
## Troubleshooting
## If Something Goes Wrong
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting Cursor after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
## Next Steps
**Plugin not working?** Close Cursor and open it again.
Once configured, your coding time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy coding!
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start coding with AI help! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.

View file

@ -1,29 +1,37 @@
# IntelliJ IDEA Setup Guide
# How to Track Time in IntelliJ IDEA
![IntelliJ IDEA](/images/editor-icons/intellij-idea-128.png)
Follow these steps to start tracking your coding time in IntelliJ IDEA with Hackatime.
Let's set up IntelliJ IDEA to count how much time you spend coding in Java!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with IntelliJ IDEA.
## Step 3: Install IntelliJ IDEA Plugin
## Step 3: Add the Plugin to IntelliJ IDEA
Follow the detailed plugin installation instructions on the [WakaTime IntelliJ IDEA page](https://wakatime.com/intellij-idea).
1. Open IntelliJ IDEA
2. Go to **File****Settings** (on Mac: **IntelliJ IDEA****Preferences**)
3. Click **Plugins** on the left
4. Click the **Marketplace** tab at the top
5. Type "WakaTime" in the search box
6. Click **Install** next to WakaTime
7. Click **Restart IDE** when it asks
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
That's it! The plugin will use your settings from Step 2.
## Troubleshooting
## If Something Goes Wrong
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting IntelliJ IDEA after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
## Next Steps
**Plugin not working?** Close IntelliJ IDEA and open it again.
Once configured, your coding time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy coding!
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start coding! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.

View file

@ -1,29 +1,37 @@
# PyCharm Setup Guide
# How to Track Time in PyCharm
![PyCharm](/images/editor-icons/pycharm-128.png)
Follow these steps to start tracking your coding time in PyCharm with Hackatime.
Let's set up PyCharm to count how much time you spend writing Python code!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with PyCharm.
## Step 3: Install PyCharm Plugin
## Step 3: Add the Plugin to PyCharm
Follow the detailed plugin installation instructions on the [WakaTime PyCharm page](https://wakatime.com/pycharm).
1. Open PyCharm
2. Go to **File****Settings** (on Mac: **PyCharm****Preferences**)
3. Click **Plugins** on the left
4. Click the **Marketplace** tab at the top
5. Type "WakaTime" in the search box
6. Click **Install** next to WakaTime
7. Click **Restart IDE** when it asks
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
That's it! The plugin will use your settings from Step 2.
## Troubleshooting
## If Something Goes Wrong
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting PyCharm after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
## Next Steps
**Plugin not working?** Close PyCharm and open it again.
Once configured, your coding time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy coding!
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start writing Python code! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.

View file

@ -1,29 +1,38 @@
# Sublime Text Setup Guide
# How to Track Time in Sublime Text
![Sublime Text](/images/editor-icons/sublime-text-128.png)
Follow these steps to start tracking your coding time in Sublime Text with Hackatime.
Let's set up Sublime Text to count how much time you spend coding!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with Sublime Text.
## Step 3: Install Sublime Text Plugin
## Step 3: Add the Plugin to Sublime Text
Follow the detailed plugin installation instructions on the [WakaTime Sublime Text page](https://wakatime.com/sublime-text).
1. Open Sublime Text
2. Go to **Tools****Command Palette** (or press **Ctrl+Shift+P** on Windows, **Cmd+Shift+P** on Mac)
3. Type "install" and choose **Package Control: Install Package**
4. Wait a moment, then type "WakaTime"
5. Click on **WakaTime** to install it
6. It will ask for your API key - just press Enter (it uses your settings from Step 2)
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
That's it! The plugin will use your settings from Step 2.
## Troubleshooting
## If Something Goes Wrong
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting Sublime Text after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
## Next Steps
**Plugin not working?** Close Sublime Text and open it again.
Once configured, your coding time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy coding!
**Don't have Package Control?** Go to [packagecontrol.io](https://packagecontrol.io/installation) to install it first.
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start coding! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.

View file

@ -1,29 +1,41 @@
# Unity Setup Guide
# How to Track Time in Unity
![Unity](/images/editor-icons/unity-128.png)
Follow these steps to start tracking your game development in Unity with Hackatime.
Let's set up Unity to count how much time you spend making games!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with Unity.
## Step 3: Install Unity Plugin
## Step 3: Add the Plugin to Unity
Follow the detailed plugin installation instructions on the [WakaTime Unity page](https://wakatime.com/unity).
There are a few different Unity plugins. Here's the easiest one:
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
1. Open Unity Hub and start a project
2. Go to this GitHub page: [Unity WakaTime Plugin](https://github.com/bengsfort/WakaTime-Unity)
3. Click the green **Code** button, then **Download ZIP**
4. Unzip the file you downloaded
5. In Unity, go to **Assets****Import Package** → **Custom Package**
6. Find the unzipped folder and select the `.unitypackage` file
7. Click **Import** on everything
## Troubleshooting
After installing, the plugin will use your settings from Step 2.
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting Unity after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
## If Something Goes Wrong
## Next Steps
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
Once configured, your activity time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy game developing!
**Plugin not working?** Close Unity and open it again.
**Package Manager not working?** Make sure you're connected to the internet.
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start making your game! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.

View file

@ -1,29 +1,45 @@
# Vim Setup Guide
# How to Track Time in Vim
![Vim](/images/editor-icons/vim-128.png)
Follow these steps to start tracking your coding time in Vim with Hackatime.
Let's set up Vim to count how much time you spend coding!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with Vim.
## Step 3: Install Vim Plugin
## Step 3: Add the Plugin to Vim
Follow the detailed plugin installation instructions on the [WakaTime Vim page](https://wakatime.com/vim).
### Easy Way (with vim-plug)
1. Add this line to your `.vimrc` file:
```
Plug 'wakatime/vim-wakatime'
```
2. Save the file and restart Vim
3. Type `:PlugInstall` in Vim and press Enter
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
### Simple Way (copy and paste)
Copy and paste this into your terminal:
```bash
echo "Plugin 'wakatime/vim-wakatime'" >> ~/.vimrc && vim +PluginInstall
```
## Troubleshooting
That's it! The plugin will use your settings from Step 2.
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting Vim after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
## If Something Goes Wrong
## Next Steps
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
Once configured, your coding time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy coding!
**Plugin not working?** Close Vim and open it again.
**Don't know how to edit .vimrc?** Type `:e ~/.vimrc` in Vim to open it.
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start coding! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.

View file

@ -1,29 +1,35 @@
# VS Code Setup Guide
# How to Track Time in VS Code
![VS Code](/images/editor-icons/vs-code-128.png)
Follow these steps to start tracking your coding time in VS Code with Hackatime.
Let's set up VS Code to count how much time you spend coding!
## Step 1: Log into Hackatime
## Step 1: Make a Hackatime Account
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
Go to [Hackatime](https://hackatime.hackclub.com) and make an account. Then log in.
## Step 2: Run the Setup Script
## Step 2: Get Your Settings Ready
Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) to automatically configure your API key and endpoint. This ensures everything works perfectly with Hackatime.
Click this link to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup). It will set up your account so it works with VS Code.
## Step 3: Install VS Code Plugin
## Step 3: Add the Plugin to VS Code
Follow the detailed plugin installation instructions on the [WakaTime VS Code page](https://wakatime.com/vs-code).
1. Open VS Code
2. Click the squares icon on the left (Extensions)
3. Type "WakaTime" in the search box
4. Click the **Install** button next to WakaTime
5. VS Code might ask you to restart - click **Reload** if it does
The WakaTime plugin will automatically use your Hackatime configuration after running the setup script.
That's it! The plugin will use your settings from Step 2.
## Troubleshooting
## If Something Goes Wrong
- **Not seeing your time?** Make sure you completed the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) first
- **Plugin not working?** Try restarting VS Code after installation
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
**Can't see your time?** Go back to the [setup page](https://hackatime.hackclub.com/my/wakatime_setup) and try again.
## Next Steps
**Plugin not working?** Close VS Code and open it again.
Once configured, your coding time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy coding!
**Still having trouble?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) - look for the #hackatime-dev channel.
## What Happens Next
Start coding! Your time will show up on your [Hackatime page](https://hackatime.hackclub.com) in a few minutes.