Skip to content

docs: improve README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# Applications for Fast Setup on Ubuntu

[![Bash Script CI](https://github.com/yursds/First-Setup-Apps/actions/workflows/ci.yml/badge.svg)](https://github.com/yursds/First-Setup-Apps/actions/workflows/ci.yml)
Expand Down Expand Up @@ -86,10 +88,11 @@ The following commands should be run from the main directory, which is named `Fi

### Installation

Run in the terminal from the main folder `First_Setup_Apps`:
Run in the terminal from the main folder `First-Setup-Apps`:
```bash
./install_apt.sh
```
> **Tip**: Append `--auto` (e.g., `./install_apt.sh --auto`) for headless or CI environments that do not have a GUI.
Comment on lines +91 to +95

@coderabbitai coderabbitai Bot Aug 13, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
printf '%s\n' '--- README references ---'
rg -n -C 3 'First[-_]Setup[-_]Apps|install_apt\.sh|--auto' README.md
printf '%s\n' '--- matching files and workflow references ---'
git ls-files | rg '(^|/)(First[-_]Setup[-_]Apps|install_apt\.sh|.*workflow.*|\.github/)' || true
rg -n -C 2 'First[-_]Setup[-_]Apps|install_apt\.sh|--auto' .github 2>/dev/null || true

Repository: yursds/First-Setup-Apps

Length of output: 2247

🏁 Script executed:

#!/bin/bash
printf '%s\n' '--- repository identity ---'
git remote -v 2>/dev/null || true
printf '%s\n' '--- README setup section ---'
sed -n '68,103p' README.md
printf '%s\n' '--- repository files relevant to setup ---'
git ls-files | rg '(^|/)(install_apt\.sh|uninstall_apt\.sh|README\.md)$'
printf '%s\n' '--- GitHub repository URL checks ---'
for url in \
  'https://github.com/yursds/First-Setup-Apps' \
  'https://github.com/yursds/First_Setup_Apps'
do
  printf '%s: ' "$url"
  curl -L -s -o /dev/null -w '%{http_code} %{url_effective}\n' "$url"
done

Repository: yursds/First-Setup-Apps

Length of output: 1581

Use First-Setup-Apps consistently in the setup instructions.

Update the clone URL, cd command, directory note, and uninstallation context from First_Setup_Apps to First-Setup-Apps. Keep the installation command and --auto example unchanged.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 91 - 95, Update the README setup instructions to use
First-Setup-Apps consistently in the clone URL, cd command, directory note, and
uninstallation context, replacing First_Setup_Apps only in those references.
Keep the install command and --auto example unchanged.


### Uninstallation
Run in the terminal from the main folder `First_Setup_Apps`:
Expand Down