Skip to content

Commit 80612bc

Browse files
authored
Create README_V3.md
1 parent b40c6f2 commit 80612bc

File tree

1 file changed

+193
-0
lines changed

1 file changed

+193
-0
lines changed
Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
2+
***
3+
4+
# Git-Template (Version 8) by [@Seanpm2001](https://github.com/seanpm2001/)
5+
6+
## Using this template
7+
8+
| ⚠️ **Warning:** _This `README.md` file is heavily out of date. Its instructions are dated, but still relevant._ |
9+
|---|
10+
11+
Starting with version 8 of my series of templates, all the templates have been combined into one via Git branches.
12+
13+
# ⚠️ WARNING ⚠️
14+
15+
Before you complete forking this project, please make sure you have followed the following instructions, or this template will be of no use to you.
16+
17+
_The DeGoogle V2 template was used as a reference, as I haven't transformed the V8 template into a template yet at the time of writing this, and I needed a quick reference._
18+
19+
![/Setup/Graphics/Use-this-template-button.png](/Setup/Graphics/Use-this-template-button.png)
20+
21+
Click on the [use this template] button (don't fork the project)
22+
23+
![/Setup/Graphics/Include-Branches_Unchecked.png](/Setup/Graphics/Include-Branches_Unchecked.png)
24+
25+
Scroll down to the bottom and find this checkbox.
26+
27+
![/Setup/Graphics/Include-Branches_Checked.png](/Setup/Graphics/Include-Branches_Checked.png)
28+
29+
Check the box (this will fork all the branches required to use this set of templates)
30+
31+
## How to use this template
32+
33+
Once you have completed the template process listed above, you will have a fresh new repository with all the templates. The default branch is `main` but it is of no use for the template process.
34+
35+
There are currently 11 other branches. You can delete all the branches you don't want to use and set your preferred one as the default branch, or you can just switch the default branch to your preference.
36+
37+
Here is a guide to the 11 template branches:
38+
39+
> [`More branches have been added since. For now, you can find them here`](/Branches/README.md)
40+
41+
- `Template-SPM2001-Journaling` - This is my personal default journaling template for the Seanpm2001 life archive project
42+
- `Template-SPM2001-Map` - This is my personal map data journaling template for the Seanpm2001 life archive project
43+
- `Template-Snapcraft` - This is the snapcraft template for creating snap packages.
44+
- `Template-SNU-Programming-Tools` - This is the SNU Programming Tools template for SNU projects related to the IDE collection set.
45+
- `Template-SNU-Other` - This is a miscellaneous SNU template for other SNU projects.
46+
- `Template-SNU-Default` - This is the default SNU template for general SNU projects.
47+
- `Template-Meadows` - This is the template for the Meadows operating system project for its subprojects.
48+
- `Template-GitHub-Pages-language` - This is my GitHub pages template for language category organizations.
49+
- `Template-GitHub-Pages-default` - This is my GitHub pages template for general projects.
50+
- `Template-DeGoogle` - This is my template for my DeGoogle article project series.
51+
- `Template-Other` - This is my template for my other projects that don't fall under the other categories.
52+
53+
***
54+
55+
## Linguist note
56+
57+
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.
58+
59+
***
60+
61+
## Development
62+
63+
### V8 Template TODO
64+
65+
> `template` branches
66+
67+
- [x] Create template branches
68+
- [ ] 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 λ
69+
- [ ] Mobile version: success, no improvements needed (other than maybe a way to ease navigation and tell where to scroll) λ
70+
- [ ] Repo directory, for description, tags, linked, and url (if none provided, use the "no description websites or URLs provided" that GitHub uses)
71+
- [ ] UTC-7 clarification
72+
- [ ] Swisscows support
73+
- [ ] Safe.duckduckgo support
74+
- [ ] Removal of parantheses in title line
75+
- [ ] Highly advanced .gitattributes, .editorconfig, and .gitignore
76+
- [ ] Google link (but it actually points to DeGoogle, don't be a jerk about it, just call it DeGoogle)
77+
- [ ] Try to find a way to highlight more text or some other catchy way for important info, also clarify what is important λ
78+
- [ ] Bold the text for the file info section headings, and file history section with bold, add support for MIME *.mkd and *.markdown
79+
- [ ] HYBRID TEMPLATE: Mix of GitHub (pages) and Git (repository (normal))
80+
- [ ] Separate branches for each template category, fit all your templates into one
81+
- [ ] Update README files to specifically fit each branch
82+
- [ ] Fix typos
83+
- [ ] Add support for the Pull Request (PR) directory
84+
- - [ ] I have done the following steps for all branches
85+
86+
> `main` branch
87+
88+
- [ ] Make the branch list in the `!USING_THIS_TEMPLATE` instruction file into a functional link list.
89+
- [ ] Archive all 11 branches into the main branch
90+
- [x] Archive all 11 pull requests
91+
- [ ] Update README
92+
- [ ] Finish TODO list
93+
- [ ] Turn repository into template (once all other steps are done)
94+
- [ ] Add list of predecessor templates
95+
96+
> **As of 2024, Thursday, August 22nd at 07:55 pm**
97+
98+
***
99+
100+
## File info
101+
102+
- **File version:** `3 (2024 Thursday, August 22nd at 07:55 pm PST)`
103+
- **File type:** `Markdown document (*.md *.mkd *.markdown)`
104+
- **Line count (including blank lines and compiler line):** `194`
105+
106+
***
107+
108+
## File history
109+
110+
History of this file.
111+
112+
---
113+
114+
**Version 1 (Monday, 2021 September 13th at 3:45 pm)**
115+
116+
> Changes:
117+
118+
- [x] Started the file
119+
- [x] Added instructions for setup
120+
- [x] Added the todo list
121+
- [x] Added the file info section
122+
- [ ] No other changes in version 1
123+
124+
---
125+
126+
**Version 2 (Monday, 2021 September 13th at 4:28 pm)**
127+
128+
> Changes:
129+
130+
- [x] Updated the title
131+
- [x] Updated the instructions
132+
- [x] Updated the todo list
133+
- [x] Updated the file info section
134+
- [x] Added the file history section
135+
- [x] Added the footer section
136+
- [ ] No other changes in version 2
137+
138+
---
139+
140+
**Version 3 (2024, Thursday, August 22nd at 07:55 pm PST)**
141+
142+
> Changes:
143+
144+
- [x] Added a warning about the file being out of date
145+
- [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
146+
- [x] Updated the `Git Template V8 todo` section
147+
- - [x] Style changes
148+
- [x] Added the `Linguist note` section
149+
- [x] Updated the `File info` section
150+
- [x] Updated the `File history` section
151+
- - [x] Updated entries for versions 1 to 2 (style changes only)
152+
- - [x] Added an entry for version 3
153+
- - [x] Added blank template entries for versions 4 to 6
154+
- [ ] No other changes in version 3
155+
156+
---
157+
158+
**Version 4 (Coming soon)**
159+
160+
> Changes:
161+
162+
- [ ] Coming soon
163+
- [ ] No other changes in version 4
164+
165+
---
166+
167+
**Version 5 (Coming soon)**
168+
169+
> Changes:
170+
171+
- [ ] Coming soon
172+
- [ ] No other changes in version 5
173+
174+
---
175+
176+
**Version 6 (Coming soon)**
177+
178+
> Changes:
179+
180+
- [ ] Coming soon
181+
- [ ] No other changes in version 6
182+
183+
***
184+
185+
## Footer
186+
187+
You have reached the end of this file.
188+
189+
( [Back to top](#Using-this-template) | [Exit to GitHub](https://github.com/) | [Exit to Bing](https://www.bing.com/) | [Exit to DuckDuckGo](https://duckduckgo.com/) | [Exit to Safe.DuckDuckGo](https://safe.duckduckgo.com/) | [Exit to Ecosia](https://www.ecosia.org/) | [Exit to Swisscows](https://www.swisscows.com/) )
190+
191+
### EOF
192+
193+
***

0 commit comments

Comments
 (0)