Skip to content

Commit 5a35e61

Browse files
authored
Project_Language_File_V1.md
An archive of the first version of the project language file article for this projects Wiki.
1 parent ff307df commit 5a35e61

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
2+
***
3+
4+
## Project language file
5+
6+
The **project language file** is a script file that talks about itself, inserted into all projects that sets/denotes the intended/current majority programming language. It is used to increase the amount of 1 programming language over another, or give the project a programming language (even if the project isn't programming related)
7+
8+
Project language files can be written in any language that [GitHub](https://github.com) will highlight on the code percentage section (such as Python (blue), JavaScript (yellow), HTML (orange) and more) This discludes markdown, xml, svg, rst, mediawiki, yaml, ini, and many more types.
9+
10+
Project language files are just a decoration, they are completely separate from the project. Removing them should not (and will not) affect functionality. Project language files are always placed at the root of the projects directory.
11+
12+
The syntax goes as follows:
13+
14+
1. `// Start of script` (line)
15+
16+
2. Comment with the program output
17+
18+
3. Normal programming language headers and imports (`#include`, `int main()`, `etc`)
19+
20+
4. An output statement with the same output as 1 (above)
21+
22+
5. Commented file info
23+
24+
6. `// End of script (line)`
25+
26+
For python projects, or projects with input/output, this is how it goes:
27+
28+
1. `# Start of script` (line)
29+
30+
2. Comment with the program output
31+
32+
3. Normal programming language headers and imports (`#include`, `int main()`, `etc`)
33+
34+
4. An output statement with the same output as 1 (above)
35+
36+
5. Exit condition output input (ie: `noMore = input("Press [ENTER] key to quit")` )
37+
38+
6. Quit string for when any input is given, that stays on the screen until the window closes (usually: `print("The program has now been closed. If the window is still open, try pressing the close button. If this doesn't work, end the process/task with a task manager/process manager")` )
39+
40+
7. Commented file info
41+
42+
8. `# End of script` (line)
43+
44+
For languages that let you title the program (such as Eiffel, FORTRAN, BASIC, and many others) the program name is usually written as `projectLanguageFile`, `languageFile`, or something else that is similar, as follows:
45+
46+
1. `// Start of script` (line)
47+
48+
2. Comment with the program output
49+
50+
3. Normal programming language headers and imports (`#include`, `int main()`, `etc`)
51+
52+
4. Program name (`appName = "projectLanguageFile"`)
53+
54+
5. An output statement with the same output as 1 (above)
55+
56+
6. Commented file info
57+
58+
7. `// End of script` (line)
59+
60+
The syntax is written differently depending on the programming language, but it always follows this order.
61+
62+
The comment for a project language file is usually related to a pun or something related to the name of the project, or what the project is mostly written in. Some examples being:
63+
64+
> The Tiny Tower image repo is written in **Eiffel**, as it is the only programming language I know based off a tower (like the **Eiffel** tower)
65+
66+
> My battery image repository is written in **Assembly**, as batteries typically require **assembly**.
67+
68+
> My mountain image repository is written in **C**, as I can **C** (see) the mountain from my house
69+
70+
> My AdVenture Capitalist image repository is written in **C++**, as **C++** has classes, capitalism also has economic classes. In reverse, my AdVenture Communist image repository is written in **C**, as **C** was originally a classless language, and Communism doesn't have economical classes.
71+
72+
However, sometimes I can't come up with a pun. Some exceptions have been made for this:
73+
74+
> Projects related to a farm or ranch are normally written in **Vala**.
75+
76+
> Projects that are for something I don't like too much are written in languages I don't like that much, such as **Go** (2009 language by Google)
77+
78+
This is all the info you need to know about the project language file system by Sean Patrick Myrick (seanpm2001)
79+
80+
***
81+
82+
## File info
83+
84+
File type: `Markdown (*.md)`
85+
86+
File version: `1 (Wednesday, December 23rd 2020 at pm)`
87+
88+
Line count (including blank lines and compiler line): ` `
89+
90+
***

0 commit comments

Comments
 (0)