Skip to content

Commit

Permalink
Tidy README.md, remove repos.md instructions as this is now done by a…
Browse files Browse the repository at this point in the history
… GitHub workflow
  • Loading branch information
eliotsykes committed Feb 24, 2024
1 parent 7a9ffa3 commit 085cb8d
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ bundle install
echo "All done! Why not run some inspections? Run bin/rwr"
```

## How to update your local copy of real-world-rails

Pull the latest commits from this repo and update submodules:
```bash
git pull
GIT_LFS_SKIP_SMUDGE=1 git submodule update
```


## Other Real World Codebase Collections

- Real World Sinatra https://github.com/jeromedalbert/real-world-sinatra
Expand Down Expand Up @@ -142,24 +151,6 @@ Given a GitHub repo for a Rails app `githubuser/foo`:
GIT_LFS_SKIP_SMUDGE=1 git submodule add -b <DEFAULT_BRANCH> [email protected]:githubuser/foo.git apps/foo
```

Regenerate [`repos.md`](repos.md):

```bash
# Requires valid GITHUB_TOKEN
bin/get_project_data > repos.md

# OR, if GitHub GraphQL API v4 schema has changed, update cached copy of schema:
FETCH_LATEST_SCHEMA=true bin/get_project_data > repos.md
```

#### Updating your local copy of real-world-rails

Pull the latest commits from this repo and update submodules:
```bash
git pull
GIT_LFS_SKIP_SMUDGE=1 git submodule update
```

#### How to remove a git submodule

Only use this if a previously public repo has been removed:
Expand Down

0 comments on commit 085cb8d

Please sign in to comment.