diff --git a/how-to-use.md b/how-to-use.md index 28f2d8e..bc3f913 100644 --- a/how-to-use.md +++ b/how-to-use.md @@ -31,26 +31,7 @@ I would greatly appreciate if you set a profile picture for your account! --- -## 2. Generate an Access Token - -Go to [https://git.sulejmani.xyz/](https://git.sulejmani.xyz/) and open your **Settings**. - -![Navigate Settings](/docs/navigate_settings.png) - -Under the **Applications** section, create a new token. - -* Check all permissions (as shown in the image) -* Give it a clear and recognizable name - -![Generate Token](/docs/applications_generate_token.png) - -Once the token is generated, **copy and save it securely**, you won’t be able to see it again. - -![Copy Token](/docs/copy_token.png) - ---- - -## 3. Create a New Repository +## 2. Create a New Repository Still on [https://git.sulejmani.xyz/](https://git.sulejmani.xyz/), click the **+** icon in the top right corner to create a new repo. @@ -66,34 +47,25 @@ You now have your own copy of the template repo. --- -## 4. Set Up Secrets for Deployment +## 3. Set Up Secrets for Deployment Go to your repository's **Settings**. ![Navigate Repo Settings](/docs/navigate_repository_settings.png) -Then under **Actions** open the **Secrets** tab and add this: - -| Secret Name | Secret Value | -| ----------- | -------------------------- | -| `TOKEN` | The token you just created | - -![Add Secret](/docs/secret.png) - Then under **Actions** open the **Variables** tab and add these two: | Variable Name | Variable Value | | -------------------- | ------------------- | -| `CONTAINER_REGISTRY` | `git.sulejmani.xyz` | | `OSUID` | Your osu player id | -So in my case my osu profile is https://osu.ppy.sh/users/13792719 and I use 13792719 +So in my case my osu profile is `https://osu.ppy.sh/users/13792719` and I use `13792719` ![Example Variables](/docs/example_variables.png) --- -## 5. Clone the Repository +## 4. Clone the Repository If you don’t have Git installed, download it here: 👉 [https://git-scm.com/downloads/win](https://git-scm.com/downloads/win) @@ -111,7 +83,7 @@ git clone https://git.sulejmani.xyz/{yourusername}/{yourrepositoryname}.git --- -## 6. Prepare Your Skins +## 5. Prepare Your Skins In your cloned repo, open `hardlink-songs-folder.bat`. @@ -132,7 +104,7 @@ Run the batch file by double-clicking it. --- -## 7. Change Skin Order, add descriptions, and ignore Skins. +## 6. Change Skin Order, add descriptions, and ignore Skins. ### Skin Order This is optional, but recommended. In the `workflows` folder, open `skins.json`. @@ -170,7 +142,7 @@ So in this example if a Skin has WhiteCat or Vaxei in the name, it will not be u --- -## 8. Upload Your Skins +## 7. Upload Your Skins Open a terminal (cmd or PowerShell) in your repo directory: @@ -191,7 +163,7 @@ Your skins will now be uploaded. --- -## 9. Monitor Upload Progress +## 8. Monitor Upload Progress Go to your repo's **Actions** tab. @@ -205,7 +177,7 @@ If something goes wrong, check the logs—or just ping me on Discord. --- -## 10. Update Skins in the Future +## 9. Update Skins in the Future To update your skins later: @@ -221,19 +193,19 @@ git push --- -11. Handle duplicate skin.ini names +## 10. Handle duplicate skin.ini names You might see Skins that show up with the exact same name in your README.md, this isn't a problem but if you would want to fix that you would need to go in to your skin and rename the name part of your skin.ini. --- -### 12. Adding your skin to https://git.sulejmani.xyz/osc/skins +## 11. Adding your skin to https://git.sulejmani.xyz/osc/skins After you did every step it should be in https://git.sulejmani.xyz/osc/skins after a couple minutes, if it doesn't show up please message me on Discord. --- -## 13. Troubleshooting +## 12. Troubleshooting ### Add Skin order, add skin descriptions