Skip to content

Commit

Permalink
README.md [V3]
Browse files Browse the repository at this point in the history
  • Loading branch information
seanpm2001 authored Aug 23, 2024
1 parent 6236414 commit 66769f6
Showing 1 changed file with 73 additions and 70 deletions.
143 changes: 73 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@

## Using this template

| ⚠️ **Warning:** _This `README.md` file is heavily out of date. Its instructions are dated, but still relevant._ |
|---|

Starting with version 8 of my series of templates, all the templates have been combined into one via Git branches.

# ⚠️ WARNING ⚠️
Expand Down Expand Up @@ -33,149 +36,149 @@ There are currently 11 other branches. You can delete all the branches you don't

Here is a guide to the 11 template branches:

`Template-SPM2001-Journaling` - This is my personal default journaling template for the Seanpm2001 life archive project

`Template-SPM2001-Map` - This is my personal map data journaling template for the Seanpm2001 life archive project

`Template-Snapcraft` - This is the snapcraft template for creating snap packages.

`Template-SNU-Programming-Tools` - This is the SNU Programming Tools template for SNU projects related to the IDE collection set.

`Template-SNU-Other` - This is a miscellaneous SNU template for other SNU projects.

`Template-SNU-Default` - This is the default SNU template for general SNU projects.
> [`More branches have been added since. For now, you can find them here`](/Branches/README.md)
`Template-Meadows` - This is the template for the Meadows operating system project for its subprojects.
- `Template-SPM2001-Journaling` - This is my personal default journaling template for the Seanpm2001 life archive project
- `Template-SPM2001-Map` - This is my personal map data journaling template for the Seanpm2001 life archive project
- `Template-Snapcraft` - This is the snapcraft template for creating snap packages.
- `Template-SNU-Programming-Tools` - This is the SNU Programming Tools template for SNU projects related to the IDE collection set.
- `Template-SNU-Other` - This is a miscellaneous SNU template for other SNU projects.
- `Template-SNU-Default` - This is the default SNU template for general SNU projects.
- `Template-Meadows` - This is the template for the Meadows operating system project for its subprojects.
- `Template-GitHub-Pages-language` - This is my GitHub pages template for language category organizations.
- `Template-GitHub-Pages-default` - This is my GitHub pages template for general projects.
- `Template-DeGoogle` - This is my template for my DeGoogle article project series.
- `Template-Other` - This is my template for my other projects that don't fall under the other categories.

`Template-GitHub-Pages-language` - This is my GitHub pages template for language category organizations.

`Template-GitHub-Pages-default` - This is my GitHub pages template for general projects.
***

`Template-DeGoogle` - This is my template for my DeGoogle article project series.
## Linguist note

`Template-Other` - This is my template for my other projects that don't fall under the other categories.
the GitHub linguist (as of 2024, Thursday, August 22nd) doesn't show the language of individual branches until forked and set as the default branch. Sometimes you may need to make 1 commit before it shows on new repositories (HTML will always be shown first) The GitHub linguist seems to only display the languages of the main branch.

***

## Development

### V8 Template TODO

`template` branches
> `template` branches
- [x] Create template branches

- [ ] Too much disclaimer, try to find out how to do a dropdown (without turning the entire page into a giant text box) or comment some of it out for now λ

- [ ] Mobile version: success, no improvements needed (other than maybe a way to ease navigation and tell where to scroll) λ

- [ ] Repo directory, for description, tags, linked, and url (if none provided, use the "no description websites or URLs provided" that GitHub uses)

- [ ] UTC-7 clarification

- [ ] Repo directory, for description, tags, linked, and url (if none provided, use the "no description websites or URLs provided" that GitHub uses)
- [ ] UTC-7 clarification
- [ ] Swisscows support

- [ ] Safe.duckduckgo support

- [ ] Removal of parantheses in title line

- [ ] Highly advanced .gitattributes, .editorconfig, and .gitignore

- [ ] Google link (but it actually points to DeGoogle, don't be a jerk about it, just call it DeGoogle)

- [ ] Try to find a way to highlight more text or some other catchy way for important info, also clarify what is important λ

- [ ] Bold the text for the file info section headings, and file history section with bold, add support for MIME *.mkd and *.markdown

- [ ] HYBRID TEMPLATE: Mix of GitHub (pages) and Git (repository (normal))

- [ ] Separate branches for each template category, fit all your templates into one

- [ ] Update README files to specifically fit each branch

- [ ] Fix typos

- [ ] Add support for the Pull Request (PR) directory

- - [ ] I have done the following steps for all branches

`main` branch
> `main` branch
- [ ] Make the branch list in the `!USING_THIS_TEMPLATE` instruction file into a functional link list.

- [ ] Archive all 11 branches into the main branch

- [x] Archive all 11 pull requests

- [ ] Update README

- [ ] Finish TODO list

- [ ] Turn repository into template (once all other steps are done)
- [ ] Add list of predecessor templates

As of 2021 Monday, September 13th at 2:31 pm
> **As of 2024, Thursday, August 22nd at 07:55 pm**
***

## File info

**File version:** `2 (2021 Monday, September 13th at 4:28 pm)`

**File type:** `Markdown document (*.md *.mkd *.markdown)`

**Line count (including blank lines and compiler line):** `191`
- **File version:** `3 (2024 Thursday, August 22nd at 07:55 pm PST)`
- **File type:** `Markdown document (*.md *.mkd *.markdown)`
- **Line count (including blank lines and compiler line):** `194`

***

## File history

History of this file.

---

**Version 1 (Monday, 2021 September 13th at 3:45 pm)**

> Changes:
> * Started the file
- [x] Started the file
- [x] Added instructions for setup
- [x] Added the todo list
- [x] Added the file info section
- [ ] No other changes in version 1

> * Added instructions for setup
---

> * Added the todo list
**Version 2 (Monday, 2021 September 13th at 4:28 pm)**

> * Added the file info section
> Changes:
> * No other changes in version 1
- [x] Updated the title
- [x] Updated the instructions
- [x] Updated the todo list
- [x] Updated the file info section
- [x] Added the file history section
- [x] Added the footer section
- [ ] No other changes in version 2

**Version 2 (Monday, 2021 September 13th at 4:28 pm)**
---

> Changes:
**Version 3 (2024, Thursday, August 22nd at 07:55 pm PST)**

> * Updated the title
> Changes:
> * Updated the instructions
- [x] Added a warning about the file being out of date
- [x] Updated the `How to use this template` section to clarify where the rest of the branches can be found and to change the style
- [x] Updated the `Git Template V8 todo` section
- - [x] Style changes
- [x] Added the `Linguist note` section
- [x] Updated the `File info` section
- [x] Updated the `File history` section
- - [x] Updated entries for versions 1 to 2 (style changes only)
- - [x] Added an entry for version 3
- - [x] Added blank template entries for versions 4 to 6
- [ ] No other changes in version 3

> * Updated the todo list
---

> * Updated the file info section
**Version 4 (Coming soon)**

> * Added the file history section
> Changes:
> * Added the footer section
- [ ] Coming soon
- [ ] No other changes in version 4

> * No other changes in version 2
---

**Version 3 (Coming soon)**
**Version 5 (Coming soon)**

> Changes:
> * Coming soon
- [ ] Coming soon
- [ ] No other changes in version 5

> * No other changes in version 3
---

**Version 4 (Coming soon)**
**Version 6 (Coming soon)**

> Changes:
> * Coming soon
> * No other changes in version 4
- [ ] Coming soon
- [ ] No other changes in version 6

***

Expand Down

0 comments on commit 66769f6

Please sign in to comment.