Skip to content

Commit

Permalink
[Enh]: Change README Format
Browse files Browse the repository at this point in the history
- First section titled TLDR
- Move load script before baseline comment
  • Loading branch information
seandenigris committed Nov 5, 2023
1 parent 1aed650 commit cfe9842
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/SmallWorld-Core/SmallGitHubRepository.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,24 @@ SmallGitHubRepository >> hostname [
SmallGitHubRepository >> readme [

| template legalPage legalMarkdown |
template := '# {project}
template := '# TLDR
TLDR: {description}
# Overview
NB. This section is an export of the class comment of {baseline}. When viewed from inside the system, it is live, dynamic and beautiful. "Just the markdown" only gives you a taste. We suggest you dive in and view the documentation as it was intended as quickly as possible - it will be more enjoyable and productive!
{baselineReadme}
{description}
# Installation
In GToolkit (preferably) or Pharo (v. 9 best supported at time of writing), do the following:
In GToolkit (preferably) or Pharo (v. 10 best supported at time of writing), do the following:
```smalltalk
{loadScript}
```
N.B. you only have to do the outer fork if on GT and you want the UI to stay responsive during the load.
# Overview
NB. Much of the following is an export of the class comment of {baseline}. When viewed from inside the system, it is live, dynamic and beautiful. "Just the markdown" only gives you a taste. We suggest you dive in and view the documentation as it was intended as quickly as possible - it will be more enjoyable and productive!
{baselineReadme}
{legal}'.

legalPage := LeDatabasesRegistry defaultLogicalDatabase pageNamed: 'Publishing Private Repos'.
Expand Down

0 comments on commit cfe9842

Please sign in to comment.