Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apickledwalrus/engcmp0600-programming-manual

Programming Language Manual for ENGCMP0600
https://github.com/apickledwalrus/engcmp0600-programming-manual

Last synced: about 1 month ago
JSON representation

Programming Language Manual for ENGCMP0600

Host: GitHub
URL: https://github.com/apickledwalrus/engcmp0600-programming-manual
Owner: APickledWalrus
License: mit
Archived: true
Created: 2023-03-02T21:49:51.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-03-23T21:03:48.000Z (over 1 year ago)
Last Synced: 2024-10-11T03:18:52.833Z (about 1 month ago)
Language: HTML
Homepage: https://apickledwalrus.github.io/programming-manual/
Size: 793 KB
Stars: 0
Watchers: 1
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Introduction
This programming manual serves as an open source database on programming languages. The database details information regarding the language's origins, applications, downsides, statistics, and more. Due to the open source nature of this project, we are open to edits that add more languages, improve accessibility, and refine existing content. As more languages establish, the website will update accordingly to keep up with current trends in programming. Our manual intends to help those who may not be sure what language would best suit their needs as well as introduce programmers to other languages they have yet to learn.

# Guidelines to Contributing
The following are the rules to abide by when creating and adding onto new language pages(This list may be updated in the future):
1. Use the "example.md" in the pages folder on the Github repository as a guide to orienting information.
2. Maintain alphabetical ordering with the header's language list.
3. Cite where information contributing to the site was taken from.
4. All information must be accurate and traceable.
5. All code must compile and run properly.
6. Text content must follow standard grammatical conventions.
7. Words must all be correctly spelled.

# FAQ
#### What is this programming manual?
A database with information on various programming languages.
More information can be found at the [elevator pitch](https://apickledwalrus.github.io/programming-manual/project-elevator-pitch/index.html).

#### How do I view the content?
The manual can be accessed at [https://apickledwalrus.github.io/programming-manual/](https://apickledwalrus.github.io/programming-manual/).
Different pages are accessed by clicking on the various language names on the head bar.

#### How do I compare languages?
Side by side comparisions can be done by first clicking on the "compare" button on the header and then selecting a right and left language.

#### How do I contribute?
1. Fork the GitHub repository.
2. Make changes as desired following the general template.
* The general template can be found under the pages folder as "example.md".
3. Once content with the edits, do a pull request.
4. Request acceptance/denial results release within 7 days.

#### Why weren't my edits accepted?
Requests are only denied if they do not abide the guidelines or the inclusion/ethics policies.

#### Why isn't the page content updating?
Give the website a few minutes at least to update. If the site doesn't update with the newly added information, please contact [email protected].

# Inclusion
Equity, diversity, and inclusion are key to our project. Regardless of identity and background, we aim to keep our project open and accessible to all potential contributors to this language database. We actively strive to combat discrimination. A wide range of perspectives helps the project grow and evolve as well as encourage intellectual discourse on computing languages.

# Ethics
Due to the open-source nature of this project, individuals may add on new content or edit current content. Contributors should keep in mind basic code of conduct regarding collaboration. Only changes that comply with our set expectations and values will be considered as additions to this database. Plagiarism is not tolerated and we expect contributors to provide source links as well for other collaborators to be credited appropriately. Hateful speech and private personal information are also not allowed on pages. Lastly, all of our database’s users and contributors reserve the right to confidentiality.

# Version History
|ID | Date (MM/DD/YYYY) | Description |
|-----|-------------------|------------------------------------|
|1 | 03-23-2023 | MVP (minimum viable product) ready |

# Credits

[PittFuego/elevator-pitch-generator](https://github.com/Pitt-Fuego/elevator-pitch-generator)

[zerodevx/zero-md](https://github.com/zerodevx/zero-md)